Interface: RoomfulAdapter\<TPresence, TCursor\>
@roomful/svelte / RoomfulAdapter
Interface: RoomfulAdapter<TPresence, TCursor>
Section titled “Interface: RoomfulAdapter<TPresence, TCursor>”Defined in: packages/svelte/src/index.ts:852
Exposes the public Svelte adapter API.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
TCursor
Section titled “TCursor”TCursor extends CursorData = CursorData
The custom cursor payload shape.
Properties
Section titled “Properties”activity
Section titled “activity”activity:
ActivityStore
Defined in: packages/svelte/src/index.ts:859
Exposes the shared room activity feed store plus the record control.
agentApprovals
Section titled “agentApprovals”agentApprovals:
AgentApprovalsStore
Defined in: packages/svelte/src/index.ts:865
Exposes the agent-approval proposals store plus the pending sub-store and
the approve/reject/propose controls.
awareness
Section titled “awareness”awareness:
AwarenessStore
Defined in: packages/svelte/src/index.ts:875
Exposes the awareness store.
comments
Section titled “comments”comments:
CommentsStore
Defined in: packages/svelte/src/index.ts:880
Exposes the collaborative comments store plus the thread mutators.
cursors
Section titled “cursors”cursors:
CursorStore<TCursor>
Defined in: packages/svelte/src/index.ts:892
Exposes the cursor store.
events
Section titled “events”events:
EventsNamespace<TPresence>
Defined in: packages/svelte/src/index.ts:911
Exposes the event namespace.
fieldPresence
Section titled “fieldPresence”fieldPresence:
FieldPresenceStore
Defined in: packages/svelte/src/index.ts:870
Exposes the field-presence store plus setActiveField and getFieldPeers.
history
Section titled “history”history:
HistoryStore
Defined in: packages/svelte/src/index.ts:917
Exposes the collaborative history store: the timeline plus reactive
canUndo/canRedo stores and the undo/redo controls.
locks:
LocksStore
Defined in: packages/svelte/src/index.ts:922
Exposes the store of all held locks plus acquire/release controls.
pointer
Section titled “pointer”pointer:
PointerStore
Defined in: packages/svelte/src/index.ts:935
Exposes the pointer (laser pointer) store.
presence
Section titled “presence”presence:
PresenceStore<TPresence>
Defined in: packages/svelte/src/index.ts:940
Exposes the presence store.
recording
Section titled “recording”recording:
RecordingStore
Defined in: packages/svelte/src/index.ts:946
Exposes the session-recording store: reactive isRecording, frameCount,
and durationMs plus the start/stop/replay/export controls.
state:
StateNamespace
Defined in: packages/svelte/src/index.ts:951
Exposes the shared-state namespace.
status
Section titled “status”status:
Readable<RoomStatus>
Defined in: packages/svelte/src/index.ts:956
Exposes the room connection status store.
viewport
Section titled “viewport”viewport:
ViewportStore
Defined in: packages/svelte/src/index.ts:961
Exposes the viewport store.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect():
Promise<void>
Defined in: packages/svelte/src/index.ts:887
Connects the room runtime.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when connection startup completes.
destroy()
Section titled “destroy()”destroy():
Promise<void>
Defined in: packages/svelte/src/index.ts:899
Tears down the adapter and room permanently.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when teardown completes.
disconnect()
Section titled “disconnect()”disconnect():
Promise<void>
Defined in: packages/svelte/src/index.ts:906
Disconnects the room runtime.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when disconnect teardown completes.
lockState()
Section titled “lockState()”lockState(
key):LockStateStore
Defined in: packages/svelte/src/index.ts:930
Creates a readable store for a single lock key’s resolved state.
Parameters
Section titled “Parameters”string
The lock key to observe.
Returns
Section titled “Returns”A readable store holding the lock state, or null when free.