QuestDB JavaScript Client - v5.0.0
    Preparing search index...

    Interface QwpBrowserClusterOptions

    Shared browser transport and authentication for one QWP cluster.

    interface QwpBrowserClusterOptions {
        closeTimeoutMs?: number;
        connectTimeoutMs?: number;
        failoverUrls?: readonly (string | URL)[];
        protocols?: string | string[];
        sendTimeoutMs?: number;
        sessionBootstrap?: QwpBrowserSessionBootstrapConfig;
        url: string | URL;
        webSocketFactory?: (
            url: string | URL,
            protocols?: string | string[],
        ) => QwpWebSocketLike;
    }

    Hierarchy (View Summary)

    Index

    Properties

    closeTimeoutMs? connectTimeoutMs? failoverUrls? protocols? sendTimeoutMs? sessionBootstrap? url webSocketFactory?

    Properties

    closeTimeoutMs?: number

    Maximum time allowed for a graceful WebSocket close. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    connectTimeoutMs?: number

    Node TCP/TLS connection deadline, or the complete opening deadline in a browser. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    failoverUrls?: readonly (string | URL)[]

    Additional endpoints attempted in order when the preferred endpoint fails.

    protocols?: string | string[]
    sendTimeoutMs?: number

    Maximum time a send may remain queued by the WebSocket. Defaults to 15s. Capped at 2,147,483,647ms (the host timer ceiling); a larger value throws a RangeError.

    sessionBootstrap?: QwpBrowserSessionBootstrapConfig

    Authenticates before every connection attempt. When url is omitted from this bootstrap, its REST endpoint follows the active cluster endpoint.

    url: string | URL
    webSocketFactory?: (
        url: string | URL,
        protocols?: string | string[],
    ) => QwpWebSocketLike

    Shared test or framework hook; either side may override it.

    Settings

    Member Visibility

    On This Page

    Properties