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

    Interface EntgeltatlasClientOptions

    Options for the Entgeltatlas client (engine options plus the API key).

    interface EntgeltatlasClientOptions {
        apiKey?: string;
        baseUrl?: string;
        defaultHeaders?: Record<string, string>;
        maxRedirects?: number;
        maxResponseBytes?: number;
        maxRetries?: number;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index
    apiKey? baseUrl? defaultHeaders? maxRedirects? maxResponseBytes? maxRetries? retryDelayMs? sleep? timeoutMs? transport? userAgent?
    apiKey?: string

    The X-API-Key to send (the BA client_id UUID). No key is bundled; when omitted (or blank) the header is not sent. Obtain the public key with obtainKey() (see obtain-key.ts).

    baseUrl?: string

    Base URL of the API. Defaults to https://rest.arbeitsagentur.de

    defaultHeaders?: Record<string, string>

    Extra headers sent on every request (e.g. the X-API-Key).

    maxRedirects?: number

    Number of HTTP redirects (301/302/303/307/308) to follow. Defaults to 5.

    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).

    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.

    Settings
    Member Visibility

    On This Page
    Properties