@maschinenlesbar.org/lebensmittelwarnung-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 a LebensmittelwarnungValidationError.

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

    Base URL of the API. Defaults to https://www.lebensmittelwarnung.de. A value that breaks a rule of validateBaseUrl (blank, unparseable, not http(s), a query or fragment) throws a LebensmittelwarnungValidationError.

    defaultHeaders?: Record<string, string>

    Extra headers sent on every request; names and values are checked like userAgent. Accept and User-Agent are the engine's own in any case: the request headers are { ...defaultHeaders, Accept, "User-Agent" }, so a user-agent/accept here reaches the transport next to the engine's key, which comes last and is the one the built-in transport sends. Use userAgent to set the User-Agent; Accept is fixed.

    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. The default transport aborts early; for any transport the engine checks the body it gets back.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses and reset connections (ECONNRESET, EPIPE, ECONNABORTED, undici's UND_ERR_SOCKET), 0..MAX_RETRIES (10). A refused connection, a DNS failure and a timeout are not retried. Each retry waits retryDelayMs * attempt, or the response's Retry-After when that is longer (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; default 200). A Retry-After can make a wait longer, never shorter. At most MAX_RETRY_AFTER_MS.

    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; at most MAX_TIMEOUT_MS, 2^31 - 1 ms). Enforced by the engine for every transport: the request's signal aborts at the deadline and the call rejects with a LebensmittelwarnungNetworkError.

    transport?: Transport

    Swappable transport. Defaults to the built-in node http/https transport. The engine enforces timeoutMs and maxResponseBytes for any transport, reads its headers in any case (a fetch Headers or a Map too) and its body as any ArrayBuffer view, and turns whatever it throws into a LebensmittelwarnungNetworkError.

    userAgent?: string

    Value of the User-Agent header (default lebensmittelwarnung-cli). A blank value, a control character other than tab, or a character above U+00FF throws a LebensmittelwarnungValidationError.

    Settings
    Member Visibility

    On This Page
    Properties