Skip to content
Roomful

Interface: LockAcquireOptions

@roomful/core

@roomful/core / LockAcquireOptions

Interface: LockAcquireOptions

Section titled “Interface: LockAcquireOptions”

Defined in: packages/core/src/types.ts:1242

Configures a single LockEngine.acquire attempt.

Properties

Section titled “Properties”

timeout?

Section titled “timeout?”

optional timeout: number

Defined in: packages/core/src/types.ts:1255

Waits up to this many milliseconds for the lock to become free before giving up, re-attempting as holders release or expire. Omit to resolve promptly against the current holder without waiting.

ttl?

Section titled “ttl?”

optional ttl: number

Defined in: packages/core/src/types.ts:1248

Auto-releases the lock this many milliseconds after it is acquired, even if the holder never calls LockEngine.release (for example, after a crash). Omit for a lock that only releases explicitly or on disconnect.