OptionalbaseAPI base URL used for the verification request; checked like the client's.
OptionalmaxNumber of HTTP redirects (301/302/303/307/308) to follow. Defaults to 5. Any
other 3xx, one with a missing or malformed Location, and one past this limit
surface as a DipApiError naming the target. An integer 0..MAX_REDIRECTS (10).
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. A non-negative safe integer. Checked on the body of every transport.
OptionalmaxNumber of automatic retries for transient (429/503) responses and reset
connections (isTransientNetworkError; GET/HEAD only). 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 names
it). An integer 0..MAX_RETRIES (10).
OptionalretryBase backoff between retries in milliseconds (grows linearly; default 200, at most
MAX_RETRY_AFTER_MS). A Retry-After can lengthen a wait, never shorten it.
OptionalsleepInjectable sleep, primarily for deterministic tests.
OptionalsourcePin a single source document (tests, mirrors) instead of trying each in turn.
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, else
DipValidationError). Enforced by the engine for every transport: the
transport gets an AbortSignal that fires at the deadline.
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 but tab, or a character above U+00FF is rejected with
DipValidationError.
OptionalverifyCheck the candidate against the live API before returning it (default true).
Options for
obtainKey. The request options are the API client's (EngineOptions), with the same defaults and the same checks:timeoutMs(default 30 s, 0 disables),maxResponseBytes(default 100 MiB, 0 disables),maxRetries(429/503 retries, default 2),retryDelayMs,maxRedirects(default 5) anduserAgent(defaultDEFAULT_USER_AGENT).