Interface O2WebSocketOptions

Configuration options for O2WebSocket.

interface O2WebSocketOptions {
    config: NetworkConfig;
    maxReconnectAttempts?: number;
    pingIntervalMs?: number;
    pongTimeoutMs?: number;
    reconnect?: boolean;
    reconnectDelayMs?: number;
    webSocketFactory?: (url: string) => WebSocket;
}

Properties

config maxReconnectAttempts? pingIntervalMs? pongTimeoutMs? reconnect? reconnectDelayMs? webSocketFactory?

Properties

config

config: NetworkConfig

Network endpoint configuration.

OptionalmaxReconnectAttempts

maxReconnectAttempts?: number

Maximum reconnection attempts (default: 10).

OptionalpingIntervalMs

pingIntervalMs?: number

Liveness check interval in milliseconds (default: 30000).

OptionalpongTimeoutMs

pongTimeoutMs?: number

Inactivity timeout in milliseconds — triggers reconnect if no message is received (default: 60000).

Optionalreconnect

reconnect?: boolean

Enable auto-reconnect on disconnect (default: true).

OptionalreconnectDelayMs

reconnectDelayMs?: number

Base delay between reconnects in milliseconds (default: 1000).

OptionalwebSocketFactory

webSocketFactory?: (url: string) => WebSocket

Optional WebSocket factory for custom runtimes/tests. Defaults to globalThis.WebSocket.

Settings

Member Visibility

On This Page

Properties