OptionalbaseBase URL of the API. Defaults to https://genesis.destatis.de
OptionaldefaultExtra headers sent on every request.
OptionalguestRun without an account, as the GENESIS guest user: whoami() and find() only.
Must be set explicitly when no credential is given — a client with neither
throws DestatisValidationError — and must not be combined with one.
OptionalmaxHard 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 stops reading at the cap;
for any other the engine checks the body it gets back.
OptionalmaxNumber of automatic retries for transient (429/503) responses, 0..MAX_RETRIES
(10). Each waits retryDelayMs * attempt, or the response's Retry-After when that
is longer (up to MAX_RETRY_AFTER_MS; a longer one is not retried, and the error
says so).
OptionalonCalled once per retry, right before the backoff sleep, for each retried 429/503; never when there is no retry. A throw is swallowed.
OptionalpasswordAccount password (10–50 chars).
OptionalretryBase backoff between retries in milliseconds (grows linearly); used without a
Retry-After. At most MAX_RETRY_AFTER_MS.
OptionalsleepInjectable sleep, primarily for deterministic tests.
OptionaltimeoutTime 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 is aborted at the deadline and
the call rejects with a DestatisNetworkError.
OptionaltokenA 32-char personal API token. Sent in the username header field with no
password. Not together with username/password: a token next to either is a
DestatisValidationError (TOKEN_WITH_LOGIN_PROBLEM), never a silent pick.
OptionaltransportSwappable transport. Defaults to the built-in node http/https transport. The engine
enforces timeoutMs and maxResponseBytes whatever the transport does, reads a
Headers/Map or any-case header record and any ArrayBuffer view as the body,
and turns everything a transport throws or returns malformed into a
DestatisNetworkError.
OptionaluserValue of the User-Agent header.
OptionalusernameAccount username (10 chars, may be an email). Requires password: with only
one of the two (and no token) the constructor throws DestatisValidationError.
Options for the GENESIS client (engine options plus credentials).