Interface WsConfig

Configuration for the WebSocket client.

Since

1.0.0

interface WsConfig {
    autoReconnect?: boolean;
    endpoint: string;
    maxReconnectAttempts?: number;
    pingIntervalMs?: number;
    reconnectIntervalMs?: number;
}

Properties

autoReconnect? endpoint maxReconnectAttempts? pingIntervalMs? reconnectIntervalMs?

Properties

OptionalautoReconnect

autoReconnect?: boolean

Auto-reconnect on disconnect (default true).

endpoint

endpoint: string

WebSocket endpoint URL (wss://…).

OptionalmaxReconnectAttempts

maxReconnectAttempts?: number

Maximum reconnect attempts before giving up (default 20).

OptionalpingIntervalMs

pingIntervalMs?: number

Ping interval to keep the connection alive in ms (default 30 000).

OptionalreconnectIntervalMs

reconnectIntervalMs?: number

Delay between reconnect attempts in ms (default 2000).

Settings

Member Visibility

On This Page

Properties