Interface IRealtimeClient<TOutgoing>

A running realtime WebSocket client.

interface IRealtimeClient<TOutgoing = unknown> {
    state: RealtimeClientState;
    close(code?: number, reason?: string): void;
    send(message: TOutgoing): void;
}

Type Parameters

TOutgoing = unknown

Index

Properties

Methods

Properties

`Readonly`state

state: RealtimeClientState

Current lifecycle state.

Methods

close

close(code?: number, reason?: string): void
Stops future reconnect attempts and closes the active socket.
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void
- Defined in packages/sdk/src/realtime/websocket-contracts.ts:80

send

send(message: TOutgoing): void
Serializes non-string values as JSON and sends a text frame.
Parameters
- message: TOutgoing
Returns void
- Defined in packages/sdk/src/realtime/websocket-contracts.ts:78