Provider-specific credentials are defined by the provider implementation.
OptionalcircuitOpt into a per-client circuit breaker for sustained upstream outages:
after threshold consecutive failed attempts, further requests fail
fast with a CIRCUIT_OPEN_ERROR network error until cooldownMs has
elapsed since the last failure, after which the next request is allowed
through as a probe. Off by default; when unset, no failure accounting
happens across requests.
OptionalexposeAttach the original Axios error to thrown errors as rawAxiosError
(and cause) for local debugging. Defaults to false because raw
errors can contain request configuration and bearer-token headers.
OptionalonInvoked when an attempt fails, and once more when retries are exhausted.
OptionalonInvoked just before each attempt is sent.
OptionalonInvoked after each attempt completes with the elapsed durationMs.
OptionalonInvoked before each retry wait with the scheduled delay in nextDelayMs. Falls back to per-attempt onError calls when unset.
OptionalpaceOpt into proactive request pacing driven by the x-ratelimit-* headers
of every successful response: when the reported remaining quota drops
below rateLimitFloor (default 1), the next attempt waits until the
window resets instead of discovering the limit via a 429. Off by default.
OptionalrateRemaining-quota threshold below which RequestOptions.paceWithRateLimit
delays the next request until the window resets. Defaults to 1.
OptionalretryAutomatic retries for transient failures. Defaults to the built-in
policy (maxRetries: 3, jittered exponential backoff over HTTP 429
and 5xx responses plus network and timeout errors). Pass false to
opt out and send every request exactly once, or pass a partial policy
to tune individual knobs on top of the defaults.
OptionalsignalSignal used to cancel in-flight requests.
OptionaltimeoutMilliseconds before a request is aborted. 0 disables the Axios timeout. Defaults to DEFAULT_REQUEST_TIMEOUT; timeout errors carry the effective duration as AniLinkNetworkError.timeoutMs.
Transport settings shared by every provider's slot in an AniLinkCredentials object. Provider-specific credential types extend this with their own authentication fields; the settings always apply to that provider's operations only.
See
AniLinkCredentials