OptionalbaseOptionaldefaultExtra headers sent on every request (e.g. the X-API-Key); names and values are checked like userAgent.
OptionalmaxNumber of HTTP redirects (301/302/303/307/308) to follow, 0 to MAX_REDIRECTS.
Defaults to 5. Any other 3xx, one with a missing or malformed Location, and one
past this limit surface as an EntgeltatlasApiError naming the target.
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. Checked on the body of every transport (the default one also aborts early).
Every numeric option must be a safe integer within its range; the constructor throws an EntgeltatlasValidationError otherwise (a negative or NaN timeout or cap would silently switch that guard off).
OptionalmaxNumber of automatic retries for transient (429/503) responses and reset
connections (isTransientNetworkError; GET/HEAD only), 0 to MAX_RETRIES
(default 2). Each waits the response's Retry-After (up to
MAX_RETRY_AFTER_MS; a longer one is not retried), or else retryDelayMs * attempt.
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; default 200, 0 to
MAX_RETRY_AFTER_MS). A Retry-After can lengthen a wait, never shorten it.
OptionalsleepInjectable sleep, primarily for deterministic tests.
OptionaltimeoutTime limit per request in milliseconds, covering the whole response body, not
only idle gaps: 0 to MAX_TIMEOUT_MS (2^31 - 1 ms); 0 disables it. Enforced by
the engine for every transport: the transport gets an AbortSignal that fires at
the deadline, and the call rejects then whether the transport stops or not.
OptionaltransportSwappable transport. Defaults to the built-in node http/https transport.
OptionaluserValue of the User-Agent header (default DEFAULT_USER_AGENT). A blank value, a
control character other than tab, or a character above U+00FF throws an
EntgeltatlasValidationError.
Base URL of the API. Defaults to https://rest.arbeitsagentur.de. A value that breaks a rule of validateBaseUrl (unparseable, not http(s), a query or fragment, surrounding whitespace) throws an EntgeltatlasValidationError.