A11 TypeScript API - v0.7.0
    Preparing search index...

    Interface WebSocketClientOptions

    HTTP handshake, framing, and socket backpressure options.

    This client speaks RFC 6455 WebSocket over HTTP/1.1 (via the browser WebSocket or the Node ws package). It connects directly to an A11 native server whose enable_http1 protocol option is on (the default) -- no WebSocket-over-HTTP/2 bridge is required. The HTTP version is fixed by the underlying runtime and is not configurable here.

    interface WebSocketClientOptions {
        bufferedAmountLowThreshold?: number;
        framing?: ChannelFramingOptions;
        headers?: Readonly<Record<string, string>>;
        maxBufferedAmount?: number;
        protocols?: string | readonly string[];
        webSocketFactory?: WebSocketFactory;
    }
    Index
    bufferedAmountLowThreshold? framing? headers? maxBufferedAmount? protocols? webSocketFactory?
    bufferedAmountLowThreshold?: number

    Low-water threshold used to resume a backpressured sender.

    framing?: ChannelFramingOptions

    Packetization and reassembly bounds.

    headers?: Readonly<Record<string, string>>

    Extra handshake headers; browsers cannot set arbitrary headers.

    maxBufferedAmount?: number

    Abort sends if the socket buffers more than this many bytes.

    protocols?: string | readonly string[]

    WebSocket subprotocol or ordered preference list.

    webSocketFactory?: WebSocketFactory

    Custom constructor for tests or non-browser runtimes.

    Settings
    Member Visibility

    On This Page
    Properties