interface RealtimeClientOptions

Configuration for createRealtimeClient.

Type Parameters

TIncoming = unknown

Properties

readonly
url: string

Absolute WebSocket endpoint URL.

readonly
optional
room: string

Room name re-applied to the URL on every connection.

readonly
optional
roomParameter: string

Query-string key for RealtimeClientOptions.room. Defaults to 'room'.

readonly
optional
heartbeatPayload: string

Application heartbeat text to suppress and send back. Defaults to 'ping'.

readonly
optional
webSocket: WebSocketFactory

Injectable constructor seam. Defaults to global WebSocket.

readonly
optional
timing: IClientTiming

Injectable clock and sleep seam. Defaults to createDefaultClientTiming().

Reconnect policy following an unrequested close.

readonly
optional
signal: AbortSignal

Optional external signal that permanently closes the client.

readonly
optional
parse: (data: string) => TIncoming

Parses a non-heartbeat text frame. Defaults to JSON.parse.

readonly
onMessage: (message: RealtimeMessage<TIncoming>) => void

Receives parsed application messages in arrival order.

readonly
optional
onError: (error: unknown) => void

Receives socket or payload parse errors.

readonly
optional
onStateChange: (state: RealtimeClientState) => void

Receives lifecycle transitions.

Usage

import { type RealtimeClientOptions } from "sdk/src/index.ts";