Interface: RoomEventMap\<TPresence\>
@roomful/core / RoomEventMap
Interface: RoomEventMap<TPresence>
Section titled “Interface: RoomEventMap<TPresence>”Defined in: packages/core/src/types.ts:745
Maps built-in room event names to payloads.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The custom peer presence shape.
Properties
Section titled “Properties”connected
Section titled “connected”connected:
void
Defined in: packages/core/src/types.ts:749
Fires after the room connects successfully.
disconnected
Section titled “disconnected”disconnected:
object
Defined in: packages/core/src/types.ts:764
Fires after the room disconnects.
reason?
Section titled “reason?”
optionalreason:string
error:
RoomfulError
Defined in: packages/core/src/types.ts:774
Fires when the room encounters an operational error.
offline
Section titled “offline”offline:
object
Defined in: packages/core/src/types.ts:754
Fires when the room detects the browser has gone offline.
reason?
Section titled “reason?”
optionalreason:string
online
Section titled “online”online:
void
Defined in: packages/core/src/types.ts:759
Fires when the browser returns online.
peer:join
Section titled “peer:join”peer:join:
Peer<TPresence>
Defined in: packages/core/src/types.ts:779
Fires when a remote peer joins.
peer:leave
Section titled “peer:leave”peer:leave:
Peer<TPresence>
Defined in: packages/core/src/types.ts:784
Fires when a remote peer leaves.
peer:update
Section titled “peer:update”peer:update:
Peer<TPresence>
Defined in: packages/core/src/types.ts:789
Fires when a remote peer updates its presence.
reconnecting
Section titled “reconnecting”reconnecting:
object
Defined in: packages/core/src/types.ts:769
Fires before another reconnect attempt starts.
attempt
Section titled “attempt”attempt:
number
room:empty
Section titled “room:empty”room:empty:
void
Defined in: packages/core/src/types.ts:799
Fires when the room becomes empty apart from the local peer.
room:full
Section titled “room:full”room:full:
void
Defined in: packages/core/src/types.ts:794
Fires when a join attempt fails because the room is full.