Interface: UseLocksResult
@roomful/react / UseLocksResult
Interface: UseLocksResult
Section titled “Interface: UseLocksResult”Defined in: react/src/index.ts:276
Describes the return value of useLocks.
Properties
Section titled “Properties”acquire()
Section titled “acquire()”acquire: (
key,options?) =>Promise<boolean>
Defined in: react/src/index.ts:286
Claims exclusive ownership of a key, resolving whether the local peer holds it.
Claims exclusive ownership of key. Broadcasts a claim, waits a short
bounded window for any conflicting earlier claim to surface, then resolves
to whether the local peer is the holder.
With options.timeout, keeps re-attempting until the lock frees (a holder
releases or its TTL expires) or the timeout elapses. With options.ttl, the
claim self-expires after the TTL so a crashed holder cannot hold it forever.
Parameters
Section titled “Parameters”string
The lock key to claim.
options?
Section titled “options?”LockAcquireOptions
Optional TTL and wait-timeout configuration.
Returns
Section titled “Returns”Promise<boolean>
A promise resolving true when the local peer holds the lock,
false when another peer holds it.
getHolder()
Section titled “getHolder()”getHolder: (
key) =>Peer<PresenceData> |null
Defined in: react/src/index.ts:306
Returns the peer currently holding a key, or null.
Returns the peer currently holding key, or null when the lock is free.
Parameters
Section titled “Parameters”string
The lock key to resolve.
Returns
Section titled “Returns”Peer<PresenceData> | null
The holding peer, or null.
isLocked()
Section titled “isLocked()”isLocked: (
key) =>boolean
Defined in: react/src/index.ts:301
Reports whether a key is currently held by any peer.
Reports whether key is currently held by any peer (including the local
peer).
Parameters
Section titled “Parameters”string
The lock key to test.
Returns
Section titled “Returns”boolean
true when the key has a non-expired holder.
locks:
LockState[]
Defined in: react/src/index.ts:280
Exposes the resolved state of every currently-held lock.
release()
Section titled “release()”release: (
key) =>void
Defined in: react/src/index.ts:291
Releases a lock held by the local peer.
Releases a lock held by the local peer. No-op when the local peer does not
hold key.
Parameters
Section titled “Parameters”string
The lock key to release.
Returns
Section titled “Returns”void
Nothing.
releaseAll()
Section titled “releaseAll()”releaseAll: () =>
void
Defined in: react/src/index.ts:296
Releases every lock held by the local peer.
Releases every lock currently held by the local peer.
Returns
Section titled “Returns”void
Nothing.