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

    Interface ObtainKeyOptions

    interface ObtainKeyOptions {
        maxResponseBytes?: number;
        maxRetries?: number;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        sourceUrl?: string;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }
    Index
    maxResponseBytes?: number

    Cap on the response body in bytes. Defaults to DEFAULT_MAX_RESPONSE_BYTES (100 MiB), like the API client; 0 disables it. A non-negative safe integer, as in the API client; anything else rejects with an EntgeltatlasValidationError.

    maxRetries?: number

    Retries for a transient 429/503 from the key source, 0 to MAX_RETRIES (default DEFAULT_MAX_RETRIES, 2), with the API client's policy: each waits the response's Retry-After (up to MAX_RETRY_AFTER_MS; a longer one is not retried), and never less than retryDelayMs × attempt.

    retryDelayMs?: number

    Base backoff between retries in milliseconds (default 200, at most MAX_RETRY_AFTER_MS).

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

    Injectable sleep, primarily for deterministic tests.

    sourceUrl?: string

    Override the source document (tests, mirrors).

    timeoutMs?: number

    Time limit per request in milliseconds, whole response included. Defaults to DEFAULT_TIMEOUT_MS (30 s), like the API client, so a stalled source cannot hang eval "$(entgeltatlas obtain-key --export)"; 0 disables it. 0 to MAX_TIMEOUT_MS, as in the API client; anything else rejects with an EntgeltatlasValidationError.

    transport?: Transport

    Injectable transport; defaults to the built-in node:http/https one.

    userAgent?: string

    User-Agent header (default DEFAULT_USER_AGENT). Checked like the API client's: a blank value or one an HTTP header cannot carry rejects with an EntgeltatlasValidationError.