@maschinenlesbar.org/regionalatlas-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 RegionalatlasValidationError.

    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;
    }

    Hierarchy (View Summary)

    Index
    baseUrl?: string

    Base URL of the ArcGIS data host. Defaults to the gis-idmz.nrw.de MapServer host.

    defaultHeaders?: Record<string, string>

    Extra headers sent on every request.

    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 as soon as the cap is passed; the engine also checks the body any transport returns.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses and reset connections (ECONNRESET, UND_ERR_SOCKET, …), 0..MAX_RETRIES (10). A refused connection, a DNS failure and a timeout are not retried.

    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), at most MAX_RETRY_AFTER_MS. A Retry-After can make a wait longer, never shorter.

    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 then).

    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 RegionalatlasNetworkError.

    userAgent?: string

    Value of the User-Agent header.