Skip to content

@pumpkin-plugins/static-hermes-runtime API / hermes/build / acquireHermesBuildLock

Function: acquireHermesBuildLock() ​

acquireHermesBuildLock(lockPath, options?): Promise<string>

Defined in: hermes/build.ts:321

Acquire the exclusive preparation lock, removing stale owners and waiting for active builds.

Parameters ​

lockPath ​

string

Path to the lock file created with exclusive-write semantics.

options? ​

HermesBuildLockOptions = {}

Optional filesystem, timeout, clock, wait, and process-liveness hooks.

Returns ​

Promise<string>

A unique token identifying this lock owner.

Remarks ​

A separate recovery claim serializes stale-owner removal. A claim owned by an exited process is removed only while its file identity and contents still match the stale claim that was inspected.

Throws ​

If the lock cannot be acquired before the configured timeout.

pumpkin-plugins documentation