gespenst API - v0.1.0
    Preparing search index...

    Interface WebSocketAddonOptions

    Configuration for the binary WebSocket terminal transport.

    interface WebSocketAddonOptions {
        createSocket?: (
            url: string | URL,
            protocols: string | string[],
        ) => WebSocket;
        highWaterMarkBytes?: number;
        protocols?: string | readonly string[];
        reconnect?: boolean | ReconnectOptions;
    }
    Index
    createSocket? highWaterMarkBytes? protocols? reconnect?
    createSocket?: (url: string | URL, protocols: string | string[]) => WebSocket

    Factory for custom, instrumented, or test WebSocket implementations.

    highWaterMarkBytes?: number

    Maximum queued outbound terminal bytes before backpressure is applied.

    protocols?: string | readonly string[]

    WebSocket subprotocol or ordered subprotocol list.

    reconnect?: boolean | ReconnectOptions

    Enables reconnection with defaults or a custom backoff policy.

    Settings
    Member Visibility

    On This Page
    Properties