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

    Interface DwdClientOptions

    Options for the DWD client. baseUrl is the live web service host and staticBaseUrl the bucket root, both without the version segment the client adds (/v30, /v16); a value ending in it throws a DwdValidationError.

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

    Hierarchy (View Summary)

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

    Base URL of the API. Defaults to https://app-prod-ws.warnwetter.de. A value that breaks a rule of validateBaseUrl (blank, whitespace or control characters, not http(s), a query or fragment) throws a DwdValidationError.

    maxRedirects?: number

    Number of HTTP redirects (301/302/303/307/308) to follow, 0..20. Defaults to 5. Any other 3xx (300, 304, 305, ...) is not followed and surfaces as a DwdApiError 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. Enforced by the engine for every transport.

    maxRetries?: number

    Number of automatic retries for transient (429/503) responses and reset connections, 0..MAX_RETRIES (10). 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. At most MAX_RETRY_AFTER_MS.

    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. It must pass the same rules as baseUrl; a bad value throws a DwdValidationError.

    timeoutMs?: number

    Time limit per request in milliseconds, covering the whole response body, not only idle gaps (0 = no timeout; at most MAX_TIMEOUT_MS, 2^31 - 1 ms). Enforced by the engine for every transport.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header (default dwd-cli). A blank value, a control character other than tab, or a character above U+00FF throws a DwdValidationError.

    Settings
    Member Visibility

    On This Page
    Properties