@maschinenlesbar.org/autobahn-cli
    Preparing search index...

    Interface EngineOptions

    Options for RequestEngine and the client. The numeric options must be integers within their documented range; anything else (negative, fractional, NaN, Infinity, too large) makes the constructor throw an AutobahnValidationError.

    interface EngineOptions {
        baseUrl?: string;
        maxResponseBytes?: number;
        maxRetries?: number;
        onRetry?: (event: RetryEvent) => void;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }
    Index
    baseUrl?: string

    Base URL of the API. Defaults to https://verkehr.autobahn.de

    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. At most Number.MAX_SAFE_INTEGER.

    maxRetries?: number

    Number of automatic retries for transient 429/502/503/504 responses and reset connections (isTransientNetworkError), 0..MAX_RETRIES (10); defaults to 2. Timeouts are not retried.

    onRetry?: (event: RetryEvent) => void

    Called once per retry, right before the backoff sleep, for each retried status and reset connection; never when there is no retry. A throw is swallowed.

    retryDelayMs?: number

    Base backoff between retries in milliseconds (default 200). Grows linearly per attempt for 502/503/504 and reset connections. A 429 waits at least 1 s, doubling per attempt (from this value when larger), at most 30 s. A Retry-After header takes precedence over both. At most 30 000 (the Retry-After ceiling).

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

    Injectable sleep, primarily for deterministic tests.

    timeoutMs?: number

    Per-request timeout in milliseconds (0 disables; at most MAX_TIMEOUT_MS, 2^31 - 1 ms). Defaults to 30 000. A request that times out is not retried.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header.