Interface WsServerOptions

interface WsServerOptions {
    connectionTimeout?: number;
    requestTimeout?: number;
    maxMessageSize?: number;
    autoReconnect?: boolean;
    maxReconnectAttempts?: number;
    reconnectDelay?: number;
    reconnectBackoffMultiplier?: number;
    maxReconnectDelay?: number;
    host?: string;
    maxConnections?: number;
    server?: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>;
    path?: string;
    pingInterval?: number;
    pongTimeout?: number;
    perMessageDeflate?: boolean;
}

Hierarchy

Properties

connectionTimeout? requestTimeout? maxMessageSize? autoReconnect? maxReconnectAttempts? reconnectDelay? reconnectBackoffMultiplier? maxReconnectDelay? host? maxConnections? server? path? pingInterval? pongTimeout? perMessageDeflate?

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 host

host?: string

Host to bind to

Optional maxConnections

maxConnections?: number

Maximum concurrent connections

Optional server

server?: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>

Existing HTTP(S) server to attach to

Optional path

path?: string

WebSocket path (default: "/")

Optional pingInterval

pingInterval?: number

Ping interval in milliseconds (0 to disable)

Optional pongTimeout

pongTimeout?: number

Client pong timeout in milliseconds

Optional perMessageDeflate

perMessageDeflate?: boolean

Enable per-message deflate compression

Settings

Member Visibility

Theme

On This Page

connectionTimeoutrequestTimeoutmaxMessageSizeautoReconnectmaxReconnectAttemptsreconnectDelayreconnectBackoffMultipliermaxReconnectDelayhostmaxConnectionsserverpathpingIntervalpongTimeoutperMessageDeflate