@maschinenlesbar.org/ckan-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?: string

    Base URL of the API. Defaults to https://suche.transparenz.hamburg.de (the Hamburg Transparenzportal)

    maxRedirects?: number

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

    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. Enforced by the engine for every transport: the built-in one aborts early, a custom one's body is checked when it arrives.

    Every numeric option must be a non-negative safe integer within its range; the constructor throws CkanValidationError otherwise (a negative or NaN timeout or cap would silently switch that guard off).

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses; a reset or other network error is not retried. 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 CkanApiError says so). 0 to MAX_RETRIES; defaults to 2.

    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 to MAX_RETRY_AFTER_MS (30 000); defaults to 200. 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 to MAX_TIMEOUT_MS (2^31 - 1 ms); 0 disables. It covers the whole response, body included, and the engine enforces it for every transport (the request also gets an AbortSignal that fires at the deadline).

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header. Must be sendable (see assertHeaderValue): not blank, no control characters but tab, nothing above U+00FF.