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

    Interface DwdClientOptions

    Options for the DWD client. baseUrl is the live web service host.

    interface DwdClientOptions {
        baseUrl?: string;
        maxRedirects?: number;
        maxResponseBytes?: number;
        maxRetries?: number;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        staticBaseUrl?: string;
        timeoutMs?: number;
        transport?: Transport;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index
    baseUrl? maxRedirects? maxResponseBytes? maxRetries? retryDelayMs? sleep? staticBaseUrl? timeoutMs? transport? userAgent?
    baseUrl?: string

    Base URL of the API. Defaults to https://app-prod-ws.warnwetter.de

    maxRedirects?: number

    Number of HTTP redirects (301/302/303/307/308) to follow. 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.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses.

    retryDelayMs?: number

    Base backoff between retries in milliseconds (grows linearly).

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

    Injectable sleep, primarily for deterministic tests.

    staticBaseUrl?: string

    Base URL of the static S3 bucket. Defaults to the production bucket.

    timeoutMs?: number

    Time limit per request in milliseconds, covering the whole response body, not only idle gaps (0 disables).

    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