@maschinenlesbar.org/destatis-genesis-cli
    Preparing search index...

    Interface DestatisClientOptions

    Options for the GENESIS client (engine options plus credentials).

    interface DestatisClientOptions {
        baseUrl?: string;
        defaultHeaders?: Record<string, string>;
        maxResponseBytes?: number;
        maxRetries?: number;
        password?: string;
        retryDelayMs?: number;
        sleep?: (ms: number) => Promise<void>;
        timeoutMs?: number;
        token?: string;
        transport?: Transport;
        userAgent?: string;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    baseUrl? defaultHeaders? maxResponseBytes? maxRetries? password? retryDelayMs? sleep? timeoutMs? token? transport? userAgent? username?
    baseUrl?: string

    Base URL of the API. Defaults to https://genesis.destatis.de

    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.

    maxRetries?: number

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

    password?: string

    Account password (10–50 chars).

    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; capped at MAX_TIMEOUT_MS, 2^31 - 1 ms).

    token?: string

    A 32-char personal API token. Sent in the username header field with no password. Takes precedence over username/password if both are given.

    transport?: Transport

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

    userAgent?: string

    Value of the User-Agent header.

    username?: string

    Account username (10 chars, may be an email). Requires password.

    Settings
    Member Visibility

    On This Page
    Properties