Function: injectLockState()
@roomful/angular / injectLockState
Function: injectLockState()
Section titled “Function: injectLockState()”injectLockState<
TPresence>(key):Signal<LockState|null>
Defined in: angular/src/index.ts:1340
Subscribes to the resolved state of a single lock key (the lock-on-focus
pattern: read holder to decide whether the local peer owns the key).
Must be called in an injection context.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Parameters
Section titled “Parameters”string
The lock key to observe.
Returns
Section titled “Returns”Signal<LockState | null>
The current lock state signal, resolving to null when free.