@maschinenlesbar.org/govdata-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 GovDataError.

    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://ckan.govdata.de (only undefined selects it). An http(s) URL without a query, fragment, whitespace or control characters; otherwise the constructor throws.

    maxRedirects?: number

    Number of HTTP redirects (301/302/303/307/308) to follow, 0..20. Defaults to 5. Any other 3xx, one with a missing or malformed Location, and one past this limit surface as a GovDataApiError naming the target.

    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 and reset connections, 0..MAX_RETRIES (10; default 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); used without a Retry-After. Default 200, at most MAX_RETRY_AFTER_MS.

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

    Injectable sleep, primarily for deterministic tests.

    timeoutMs?: number

    Per-request timeout in milliseconds (default 30000; 0 disables; at most 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 (default govdata-cli). Must be sendable (see assertHeaderValue): not blank, no control characters but tab, nothing above U+00FF; otherwise the constructor throws GovDataValidationError.

    Settings
    Member Visibility

    On This Page
    Properties