Function: useSharedState()
@roomful/solid / useSharedState
Function: useSharedState()
Section titled “Function: useSharedState()”useSharedState<
T,TPresence>(key,options): readonly [Accessor<T>,SharedStateSetter<T>]
Defined in: solid/src/index.ts:1626
Binds a shared state value to Solid signal semantics.
Type Parameters
Section titled “Type Parameters”T
The shared state value type.
TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Parameters
Section titled “Parameters”string
The logical binding key used to enforce a single shared-state binding per room.
options
Section titled “options”StateOptions<T>
The shared-state configuration.
Returns
Section titled “Returns”readonly [Accessor<T>, SharedStateSetter<T>]
The current shared state accessor and a React-style setter.