Interface WebSocketRoom

A named broadcast group of connections — the bidirectional analogue of the SSE plugin's channels.

Connections are removed automatically when they close, so a room never broadcasts to a dead peer.

Since

0.2.0

interface WebSocketRoom {
    name: string;
    size: number;
    add(conn: IWebSocketConnection): void;
    broadcast(
        data: string | Uint8Array<ArrayBufferLike>,
        options?: RoomBroadcastOptions,
    ): void;
    broadcastJson<T>(payload: T, options?: RoomBroadcastOptions): void;
    remove(conn: IWebSocketConnection): void;
}

Implemented by

Room

Index

Properties

Methods

add broadcast broadcastJson remove

Properties

`Readonly`name

name: string

The room name.

`Readonly`size

size: number

Number of currently open members.

Methods

add

add(conn: IWebSocketConnection): void
Adds a connection to this room.
Parameters
- conn: IWebSocketConnection
  The connection to add
Returns void
- Defined in packages/common/src/services/websocket.ts:226

broadcast

broadcast(
data: string | Uint8Array<ArrayBufferLike>,
options?: RoomBroadcastOptions,
): void
Sends a frame to every open member, skipping any closed member and any member named by options.except.
Parameters
- data: string | Uint8Array<ArrayBufferLike>
  Text as string, binary as Uint8Array
- Optionaloptions: RoomBroadcastOptions
  Broadcast options
Returns void
- Defined in packages/common/src/services/websocket.ts:240

broadcastJson

broadcastJson<T>(payload: T, options?: RoomBroadcastOptions): void
Serializes a value to JSON once and broadcasts it as a text frame.
Type Parameters
- T
  The payload type
Parameters
- payload: T
  The value to serialize
- Optionaloptions: RoomBroadcastOptions
  Broadcast options
Returns void
- Defined in packages/common/src/services/websocket.ts:248

remove

remove(conn: IWebSocketConnection): void
Removes a connection from this room.
Parameters
- conn: IWebSocketConnection
  The connection to remove
Returns void
- Defined in packages/common/src/services/websocket.ts:232