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

    Interface OparlClientOptions

    interface OparlClientOptions {
        curatedEndpoints?: readonly CuratedEndpoint[];
        defaultHeaders?: Record<string, string>;
        maxRedirects?: number;
        maxResponseBytes?: number;
        maxRetries?: number;
        registryChecks?: readonly RegistryCheck[];
        registryUrl?: string;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index
    curatedEndpoints? defaultHeaders? maxRedirects? maxResponseBytes? maxRetries? registryChecks? registryUrl? retryDelayMs? sleep? timeoutMs? transport? userAgent?
    curatedEndpoints?: readonly CuratedEndpoint[]

    Endpoints the registry lacks. Defaults to the list shipped with this package.

    defaultHeaders?: Record<string, string>

    Extra headers sent on every request.

    maxRedirects?: number

    Redirects followed per request (same host only). Defaults to 3; 0 disables.

    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.

    registryChecks?: readonly RegistryCheck[]

    Live checks of registry entries. Defaults to the checks shipped with this package.

    registryUrl?: string

    URL of the endpoint registry. Defaults to https://dev.oparl.org/api/endpoints

    retryDelayMs?: number

    Base backoff between retries in milliseconds (grows linearly).

    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). Defaults to 120 s: some council systems take well over 30 s to render a single list page.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header.

    Settings
    Member Visibility

    On This Page
    Properties