OptionalbaseBase URL of the API. Defaults to https://api.hochwasserzentralen.de/public/v1. A value that breaks a rule of validateBaseUrl (blank, not a URL, not http(s), a query or fragment) throws a HochwasserzentralenValidationError.
OptionaldefaultExtra headers sent on every request; names and values are checked like userAgent.
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 aborts early; for any
transport the engine checks the body it gets back.
OptionalmaxNumber of automatic retries for transient (429/503) responses and reset connections
(ECONNRESET, EPIPE, ECONNABORTED, undici's UND_ERR_SOCKET), 0..MAX_RETRIES
(10). A refused connection, a DNS failure and a timeout are not retried. Default 2.
OptionalonCalled 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.
OptionalretryBase backoff between retries in milliseconds (grows linearly). A Retry-After
header can lengthen a wait (up to MAX_RETRY_AFTER_MS), never shorten it below
this backoff. At most MAX_RETRY_AFTER_MS. Default 200.
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). Default 30 000.
Enforced by the engine for every transport: the request's signal aborts at the
deadline and the call rejects with a HochwasserzentralenNetworkError.
OptionaltransportSwappable transport. Defaults to the built-in node http/https transport. The engine
enforces timeoutMs and maxResponseBytes for any transport, reads its headers in any
case (a fetch Headers or a Map too) and its body as any ArrayBuffer view, and turns
whatever it throws into a HochwasserzentralenNetworkError.
OptionaluserValue of the User-Agent header (default hochwasserzentralen-cli). A blank
value, a control character other than tab, or a character above U+00FF throws
a HochwasserzentralenValidationError.
Options for RequestEngine and the client. The numeric options must be integers within their documented range; anything else (negative, fractional, NaN, Infinity, too large) makes the constructor throw a HochwasserzentralenValidationError.