bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface ConnectionOptions

    Connection options for TCP mode

    interface ConnectionOptions {
        commandTimeout?: number;
        host?: string;
        maxCommandTimeouts?: number;
        maxInFlight?: number;
        pingInterval?: number;
        pipelining?: boolean;
        poolSize?: number;
        port?: number;
        socketPath?: string;
        tls?: boolean | ClientTlsOptions;
        token?: string;
    }
    Index
    commandTimeout? host? maxCommandTimeouts? maxInFlight? pingInterval? pipelining? poolSize? port? socketPath? tls? token?
    commandTimeout?: number

    Command timeout in ms (default: 30000)

    host?: string

    Server host (default: localhost, ignored if socketPath is set)

    maxCommandTimeouts?: number

    Consecutive command timeouts (no intervening success) before the connection is concluded dead and a reconnect is forced (default: 3, 0 to disable). Recovery path for a half-open socket independent of the health-check ping. See #94.

    maxInFlight?: number

    Max commands in flight per connection (default: 100)

    pingInterval?: number

    Ping interval in ms for health checks (default: 30000, 0 to disable)

    pipelining?: boolean

    Enable TCP pipelining (default: true)

    poolSize?: number

    Connection pool size for parallel operations (default: 1, set >1 to enable pooling)

    port?: number

    Server port (default: 6789, ignored if socketPath is set)

    socketPath?: string

    Unix socket path (takes priority over host/port)

    tls?: boolean | ClientTlsOptions

    Enable TLS to the server: true (system CAs) or custom options (default: off)

    token?: string

    Auth token

    Settings
    Member Visibility

    On This Page
    Properties