Interface: LocksStore
@roomful/svelte / LocksStore
Interface: LocksStore
Section titled “Interface: LocksStore”Defined in: packages/svelte/src/index.ts:410
Readable store of all held locks augmented with acquire/release helpers.
Extends
Section titled “Extends”Readable<LockState[]>
Properties
Section titled “Properties”getHolder()
Section titled “getHolder()”getHolder: (
key) =>Peer<PresenceData> |null
Defined in: packages/svelte/src/index.ts:439
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: packages/svelte/src/index.ts:434
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.
release()
Section titled “release()”release: (
key) =>void
Defined in: packages/svelte/src/index.ts:424
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: packages/svelte/src/index.ts:429
Releases every lock held by the local peer.
Releases every lock currently held by the local peer.
Returns
Section titled “Returns”void
Nothing.
Methods
Section titled “Methods”acquire()
Section titled “acquire()”acquire(
key,options?):Promise<boolean>
Defined in: packages/svelte/src/index.ts:419
Claims exclusive ownership of a key, resolving whether the local peer holds it.
Parameters
Section titled “Parameters”string
The lock key to claim.
options?
Section titled “options?”LockAcquireOptions
Optional TTL and acquire-timeout configuration.
Returns
Section titled “Returns”Promise<boolean>
A promise resolving to whether the local peer holds the key.
subscribe()
Section titled “subscribe()”subscribe(
this,run,invalidate?):Unsubscriber
Defined in: node_modules/.pnpm/svelte@4.2.20/node_modules/svelte/types/index.d.ts:1619
Subscribe on value changes.
Parameters
Section titled “Parameters”void
Subscriber<LockState[]>
subscription callback
invalidate?
Section titled “invalidate?”Invalidator<LockState[]>
cleanup callback
Returns
Section titled “Returns”Unsubscriber
Inherited from
Section titled “Inherited from”Readable.subscribe