AniLink - v3.0.0
    Preparing search index...

    Interface ResolvedRequestOptions

    The complete, validated transport settings one request pipeline runs with, the output of resolveRequestOptions.

    Every resilience module (error normalization, pacing, circuit breaker, retry loop) reads from this shape instead of re-deriving defaults, so a request never branches on missing fields. Unlike the public RequestOptions, the defaults are already applied: timeout, exposeRawAxiosError, paceWithRateLimit, rateLimitFloor, ignorePaceDeadline, and diagnostics are always present, retry is a complete policy or null, and the keep-alive agents are resolved.

    interface ResolvedRequestOptions {
        allowPartialData: boolean;
        bypassResponseCache: boolean;
        circuitBreaker?: { cooldownMs: number; threshold: number };
        diagnostics: DiagnosticsMode;
        exposeRawAxiosError: boolean;
        httpAgent: Agent;
        httpsAgent: Agent;
        ignorePaceDeadline: boolean;
        onCircuitClose?: OnCircuitCloseHandler;
        onCircuitOpen?: OnCircuitOpenHandler;
        onError?: OnErrorHandler;
        onHookError?: OnHookErrorHandler;
        onPace?: OnPaceHandler;
        onRequestStart?: OnRequestStartHandler;
        onResponse?: OnResponseHandler;
        onRetry?: OnErrorHandler;
        paceWithRateLimit: boolean;
        rateLimitFloor: number;
        responseCache?: ResponseCache;
        retry: RetryPolicy | null;
        retryBudget?: RetryBudget;
        signal?: AbortSignal;
        timeout: number;
    }
    Index
    allowPartialData: boolean

    Whether GraphQL envelopes carrying both data and errors resolve with the data instead of throwing.

    bypassResponseCache: boolean

    Whether this request skips the response cache entirely (no lookup, no write-back).

    circuitBreaker?: { cooldownMs: number; threshold: number }

    Circuit-breaker configuration, when opted in.

    diagnostics: DiagnosticsMode

    How the library's unsolicited diagnostics are emitted; see DiagnosticsMode.

    exposeRawAxiosError: boolean

    Whether raw Axios errors are attached to thrown errors for diagnostics.

    httpAgent: Agent

    The resolved keep-alive agent for plain-HTTP requests.

    httpsAgent: Agent

    The resolved keep-alive agent for HTTPS requests.

    ignorePaceDeadline: boolean

    Whether the shared rate-limit pacing deadline is bypassed for this request.

    onCircuitClose?: OnCircuitCloseHandler

    Invoked when the circuit breaker closes.

    onCircuitOpen?: OnCircuitOpenHandler

    Invoked when the circuit breaker opens.

    onError?: OnErrorHandler

    Invoked when an attempt fails and once more when retries are exhausted.

    onHookError?: OnHookErrorHandler

    Invoked when a user-supplied lifecycle hook throws.

    onPace?: OnPaceHandler

    Invoked when proactive pacing delays the next request.

    onRequestStart?: OnRequestStartHandler

    Invoked just before each attempt is sent.

    onResponse?: OnResponseHandler

    Invoked after each attempt completes.

    onRetry?: OnErrorHandler

    Invoked before each retry wait with the scheduled delay.

    paceWithRateLimit: boolean

    Whether proactive rate-limit pacing is enabled.

    rateLimitFloor: number

    Remaining-quota threshold below which pacing delays the next request.

    responseCache?: ResponseCache

    The opt-in response cache, when configured.

    retry: RetryPolicy | null

    The complete retry policy, or null when retries are disabled.

    retryBudget?: RetryBudget

    Retry-budget configuration, when opted in.

    signal?: AbortSignal

    Signal used to cancel in-flight requests and retry waits.

    timeout: number

    Per-attempt timeout in milliseconds; 0 disables the Axios timeout.