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

    Interface EngineOptions

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

    Base URL of the API. Defaults to https://www.imis.bfs.de

    maxRedirects?: number

    Number of HTTP redirects (301/302/303/307/308) to follow, an integer from 0 to MAX_REDIRECTS (10). Defaults to 5.

    maxResponseBytes?: number

    Hard cap on response body size in bytes (defends against memory exhaustion from a hostile/buggy endpoint), a non-negative safe integer. Defaults to 100 MiB; set to 0 for no limit. Enforced by the engine for every transport.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses and reset connections (GET/HEAD only), an integer from 0 to MAX_RETRIES (10); defaults to 2. Each waits retryDelayMs * attempt, or longer if the response's Retry-After asks (up to MAX_RETRY_AFTER_MS; a longer one is not retried, and the error names the requested wait).

    onRetry?: (event: RetryEvent) => void

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

    retryDelayMs?: number

    Base backoff between retries in milliseconds (grows linearly), an integer from 0 to MAX_RETRY_AFTER_MS (30 000); the floor under any Retry-After. Defaults to 200.

    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: an integer from 0 (disables) to MAX_TIMEOUT_MS (2^31 - 1 ms). Defaults to 30 s. Enforced by the engine for every transport.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header: non-blank, no control characters (tab allowed), nothing above U+00FF. Defaults to strahlenschutz-cli.

    Settings
    Member Visibility

    On This Page
    Properties