Setu-TS
    Preparing search index...

    Interface RealtimeClientOptions<TIncoming>

    Configuration for createRealtimeClient.

    interface RealtimeClientOptions<TIncoming = unknown> {
        heartbeatPayload?: string;
        onError?: (error: unknown) => void;
        onMessage: (message: RealtimeMessage<TIncoming>) => void;
        onStateChange?: (state: RealtimeClientState) => void;
        parse?: (data: string) => TIncoming;
        reconnect?: RealtimeReconnectOptions;
        room?: string;
        roomParameter?: string;
        signal?: AbortSignal;
        timing?: IClientTiming;
        url: string;
        webSocket?: WebSocketFactory;
    }

    Type Parameters

    • TIncoming = unknown
    Index
    heartbeatPayload? onError? onMessage onStateChange? parse? reconnect? room? roomParameter? signal? timing? url webSocket?
    heartbeatPayload?: string

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

    onError?: (error: unknown) => void

    Receives socket or payload parse errors.

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

    Receives parsed application messages in arrival order.

    onStateChange?: (state: RealtimeClientState) => void

    Receives lifecycle transitions.

    parse?: (data: string) => TIncoming

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

    reconnect?: RealtimeReconnectOptions

    Reconnect policy following an unrequested close.

    room?: string

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

    roomParameter?: string

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

    signal?: AbortSignal

    Optional external signal that permanently closes the client.

    timing?: IClientTiming

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

    url: string

    Absolute WebSocket endpoint URL.

    webSocket?: WebSocketFactory

    Injectable constructor seam. Defaults to global WebSocket.

    Settings
    Member Visibility

    On This Page
    Properties