@qualithm/arrow-flight-client - v0.1.4
    Preparing search index...

    Type Alias FlightClientOptions

    Configuration options for creating a Flight client.

    type FlightClientOptions = {
        auth?: AuthOptions;
        headers?: Record<string, string>;
        nodeOptions?: http2.ClientSessionOptions | http2.SecureClientSessionOptions;
        timeoutMs?: number;
        tls?: TlsOptions;
        url: string;
    }
    Index

    Properties

    auth? headers? nodeOptions? timeoutMs? tls? url

    Properties

    auth?: AuthOptions

    Authentication options.

    • bearer: Sets Authorization header with Bearer token
    • basic: Uses Flight Handshake RPC with BasicAuth
    • none: No authentication (default)
    headers?: Record<string, string>

    Optional headers to include with every request. Useful for custom metadata. For authentication, prefer using the auth option.

    nodeOptions?: http2.ClientSessionOptions | http2.SecureClientSessionOptions

    Additional Node.js HTTP/2 session options. Advanced use only.

    timeoutMs?: number

    Request timeout in milliseconds.

    30000
    tls?: TlsOptions

    TLS options for mTLS authentication. Passed to the underlying Node.js HTTP/2 client.

    url: string

    The base URL of the Flight server. Should include protocol (http:// or https://).

    "https://flight.example.com:8815"

    Settings

    Member Visibility

    On This Page

    Properties