Function: roomful()
@roomful/svelte / roomful
Function: roomful()
Section titled “Function: roomful()”roomful<
TPresence,TCursor>(roomId,options?):RoomfulAdapter<TPresence,TCursor>
Defined in: packages/svelte/src/index.ts:973
Creates the Svelte adapter for a room.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape inferred from options.presence.
TCursor
Section titled “TCursor”TCursor extends CursorData = CursorData
The custom cursor payload shape.
Parameters
Section titled “Parameters”roomId
Section titled “roomId”string
The room identifier to create or join.
options?
Section titled “options?”RoomfulOptions<TPresence> = {}
Optional room and lifecycle configuration.
Returns
Section titled “Returns”RoomfulAdapter<TPresence, TCursor>
The Svelte adapter.