Interface: RoomfulAdapter\<TPresence, TCursor\>
@roomful/svelte / RoomfulAdapter
Interface: RoomfulAdapter<TPresence, TCursor>
Section titled “Interface: RoomfulAdapter<TPresence, TCursor>”Defined in: packages/svelte/src/index.ts:377
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”awareness
Section titled “awareness”awareness:
AwarenessStore
Defined in: packages/svelte/src/index.ts:384
Exposes the awareness store.
cursors
Section titled “cursors”cursors:
CursorStore<TCursor>
Defined in: packages/svelte/src/index.ts:396
Exposes the cursor store.
events
Section titled “events”events:
EventsNamespace<TPresence>
Defined in: packages/svelte/src/index.ts:415
Exposes the event namespace.
presence
Section titled “presence”presence:
PresenceStore<TPresence>
Defined in: packages/svelte/src/index.ts:420
Exposes the presence store.
state:
StateNamespace
Defined in: packages/svelte/src/index.ts:425
Exposes the shared-state namespace.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect():
Promise<void>
Defined in: packages/svelte/src/index.ts:391
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:403
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:410
Disconnects the room runtime.
Returns
Section titled “Returns”Promise<void>
A promise that resolves when disconnect teardown completes.