@maschinenlesbar.org/fit-connect-cli
    Preparing search index...

    Interface FitConnectClientOptions

    interface FitConnectClientOptions {
        apiVersion?: ApiVersion;
        baseUrl?: string;
        maxResponseBytes?: number;
        maxRetries?: number;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index
    apiVersion? baseUrl? maxResponseBytes? maxRetries? retryDelayMs? sleep? timeoutMs? transport? userAgent?
    apiVersion?: ApiVersion

    Routing API major version to target (path prefix). Defaults to "v2".

    baseUrl?: string

    Base URL of the API. Defaults to the production routing service.

    maxResponseBytes?: number

    Hard cap on response body size in bytes (defends against memory exhaustion from a hostile/buggy endpoint). Defaults to 100 MiB; set to 0 for no limit.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses.

    retryDelayMs?: number

    Base backoff between retries in milliseconds. Grows linearly per attempt, unless the response carries a Retry-After header, which takes precedence.

    sleep?: (ms: number) => Promise<void>

    Injectable sleep, primarily for deterministic tests.

    timeoutMs?: number

    Time limit per request in milliseconds, covering the whole response body, not only idle gaps (0 disables; capped at MAX_TIMEOUT_MS, 2^31 - 1 ms).

    transport?: Transport

    Swappable transport. Defaults to the built-in node http/https transport.

    userAgent?: string

    Value of the User-Agent header. The Routing API applies bot detection to the User-Agent: the default is accepted, but some UA strings are blocked with a 403. An empty or whitespace-only value falls back to the default.

    Settings
    Member Visibility

    On This Page
    Properties