Interface WsClientOptions

interface WsClientOptions {
    connectionTimeout?: number;
    requestTimeout?: number;
    maxMessageSize?: number;
    autoReconnect?: boolean;
    maxReconnectAttempts?: number;
    reconnectDelay?: number;
    reconnectBackoffMultiplier?: number;
    maxReconnectDelay?: number;
    protocols?: string | string[];
    headers?: Record<string, string>;
    pingInterval?: number;
    pongTimeout?: number;
}

Hierarchy

Properties

connectionTimeout? requestTimeout? maxMessageSize? autoReconnect? maxReconnectAttempts? reconnectDelay? reconnectBackoffMultiplier? maxReconnectDelay? protocols? headers? pingInterval? pongTimeout?

Properties

Optional connectionTimeout

connectionTimeout?: number

Connection timeout in milliseconds

Optional requestTimeout

requestTimeout?: number

Request timeout in milliseconds (default: 30000)

Optional maxMessageSize

maxMessageSize?: number

Maximum message size in bytes (default: 1MB)

Optional autoReconnect

autoReconnect?: boolean

Enable automatic reconnection (client only)

Optional maxReconnectAttempts

maxReconnectAttempts?: number

Maximum reconnection attempts

Optional reconnectDelay

reconnectDelay?: number

Reconnection delay in milliseconds

Optional reconnectBackoffMultiplier

reconnectBackoffMultiplier?: number

Reconnection backoff multiplier

Optional maxReconnectDelay

maxReconnectDelay?: number

Maximum reconnection delay in milliseconds

Optional protocols

protocols?: string | string[]

WebSocket subprotocols

Optional headers

headers?: Record<string, string>

Additional headers for ws package (Node.js only, ignored in browser)

Optional pingInterval

pingInterval?: number

Ping interval in milliseconds (0 to disable)

Optional pongTimeout

pongTimeout?: number

Pong timeout in milliseconds

Settings

Member Visibility

Theme

On This Page

connectionTimeoutrequestTimeoutmaxMessageSizeautoReconnectmaxReconnectAttemptsreconnectDelayreconnectBackoffMultipliermaxReconnectDelayprotocolsheaderspingIntervalpongTimeout