Interface: EventsNamespace\<TPresence\>
@roomful/svelte / EventsNamespace
Interface: EventsNamespace<TPresence>
Section titled “Interface: EventsNamespace<TPresence>”Defined in: packages/svelte/src/index.ts:309
Exposes event helpers for the adapter.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Methods
Section titled “Methods”channel()
Section titled “channel()”channel<
TPayload>(name):EventChannelStore<TPayload,TPresence>
Defined in: packages/svelte/src/index.ts:317
Creates a readable store for a custom event channel.
Type Parameters
Section titled “Type Parameters”TPayload
Section titled “TPayload”TPayload = unknown
The event payload type.
Parameters
Section titled “Parameters”string
The custom event channel name.
Returns
Section titled “Returns”EventChannelStore<TPayload, TPresence>
The bound event channel store.
emit()
Section titled “emit()”emit<
TPayload>(name,payload):void
Defined in: packages/svelte/src/index.ts:327
Broadcasts a custom event.
Type Parameters
Section titled “Type Parameters”TPayload
Section titled “TPayload”TPayload = unknown
The event payload type.
Parameters
Section titled “Parameters”string
The custom event channel name.
payload
Section titled “payload”TPayload
The payload to send.
Returns
Section titled “Returns”void
Nothing.
emitTo()
Section titled “emitTo()”emitTo<
TPayload>(peerId,name,payload):void
Defined in: packages/svelte/src/index.ts:338
Sends a custom event to a specific peer.
Type Parameters
Section titled “Type Parameters”TPayload
Section titled “TPayload”TPayload = unknown
The event payload type.
Parameters
Section titled “Parameters”peerId
Section titled “peerId”string
The target peer identifier.
string
The custom event channel name.
payload
Section titled “payload”TPayload
The payload to send.
Returns
Section titled “Returns”void
Nothing.
on<
TPayload>(name,handler):Unsubscribe
Defined in: packages/svelte/src/index.ts:348
Subscribes to a custom event channel.
Type Parameters
Section titled “Type Parameters”TPayload
Section titled “TPayload”TPayload = unknown
The event payload type.
Parameters
Section titled “Parameters”string
The custom event channel name.
handler
Section titled “handler”(payload, from) => void
The callback invoked for incoming events.
Returns
Section titled “Returns”Unsubscribe
A function that removes the listener.