Interface EngineOptions

Base URL of the API. Defaults to https://warnung.bund.de. A value that breaks a rule of validateBaseUrl (blank, whitespace or control characters, not http(s), a query or fragment) throws a NinaValidationError from the constructor.

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. A negative or non-integer value throws a NinaValidationError.

Number of automatic retries for transient (429/503) responses and reset connections (ECONNRESET, UND_ERR_SOCKET, …) (default 2). A refused connection, a DNS failure and a timeout are not retried. Each retry 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 names the requested wait). Anything but an integer from 0 to MAX_RETRIES (10) throws a NinaValidationError.

Called once per retry, right before the backoff sleep, for each retried status and reset connection; never when there is no retry. A throw is swallowed.

Base backoff between retries in milliseconds (grows linearly; default 200). A Retry-After can make a wait longer, never shorter. Anything but an integer from 0 to MAX_RETRY_AFTER_MS (30 000) throws a NinaValidationError.

Injectable sleep, primarily for deterministic tests.

Per-request timeout in milliseconds (default 30 000; 0 disables), enforced by the engine for every transport (the request's signal aborts then). Anything but an integer from 0 to MAX_TIMEOUT_MS (2^31 - 1 ms) throws a NinaValidationError — a negative or NaN value would otherwise mean no timeout.

Swappable 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 NinaNetworkError.

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