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

    Interface EngineOptions

    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? maxResponseBytes? maxRetries? onRetry? retryDelayMs? sleep? timeoutMs? transport? userAgent?
    baseUrl?: string

    Base URL of the API. Defaults to https://fragdenstaat.de. Whitespace or control characters in it are an FdsValidationError at construction.

    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. Every numeric option must be a non-negative safe integer within its range, or the constructor throws a FdsError.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses and connection resets (isTransientNetworkError), 0..MAX_RETRIES (10). Each 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 FdsApiError says so).

    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), 0..MAX_RETRY_AFTER_MS (30 000). It is also the floor under a Retry-After: the header can lengthen a wait, never shorten it.

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

    Injectable sleep, primarily for deterministic tests.

    timeoutMs?: number

    Per-request timeout in milliseconds, 0..MAX_TIMEOUT_MS (2^31 - 1 ms); 0 disables.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header (default fragdenstaat-cli): non-blank, Latin-1, no control characters but tab, or the constructor throws an FdsValidationError.

    Settings
    Member Visibility

    On This Page
    Properties