Logos DX
    Preparing search index...

    Interface EngineRequestConfig<H, P>

    Request config passed to callbacks.

    This is what callbacks receive - includes the controller that was created for the request.

    interface EngineRequestConfig<H = InstanceHeaders, P = InstanceParams> {
        attemptTimeout?: number;
        body?: BodyInit | null;
        cache?: RequestCache;
        controller: AbortController;
        credentials?: RequestCredentials;
        determineType?: DetermineTypeFn;
        headers?: DictAndT<H>;
        integrity?: string;
        keepalive?: boolean;
        method?: string;
        mode?: RequestMode;
        params?: DictAndT<P>;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        retry?: boolean | RetryConfig;
        signal?: AbortSignal;
        totalTimeout?: number;
        window?: null;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    attemptTimeout? body? cache? controller credentials? determineType? headers? integrity? keepalive? method? mode? params? priority? redirect? referrer? referrerPolicy? retry? signal? totalTimeout? window?

    Properties

    attemptTimeout?: number

    Per-attempt timeout (ms) - each retry gets fresh timeout

    Optionalbody

    body?: BodyInit | null

    A BodyInit object or null to set request's body.

    cache?: RequestCache

    A string indicating how the request will interact with the browser's cache to set request's cache.

    controller: AbortController

    The AbortController created for this request

    credentials?: RequestCredentials

    A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

    determineType?: DetermineTypeFn

    Function to determine response body type based on response

    headers?: DictAndT<H>

    Request headers (merged with instance defaults)

    integrity?: string

    A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

    keepalive?: boolean

    A boolean to set request's keepalive.

    method?: string

    A string to set request's method.

    mode?: RequestMode

    A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

    params?: DictAndT<P>

    URL parameters (merged with instance defaults)

    priority?: RequestPriority
    redirect?: RequestRedirect

    A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

    referrer?: string

    A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

    referrerPolicy?: ReferrerPolicy

    A referrer policy to set request's referrerPolicy.

    retry?: boolean | RetryConfig

    Retry configuration

    signal?: AbortSignal

    AbortSignal for request cancellation

    totalTimeout?: number

    Total timeout for entire request lifecycle including retries (ms)

    window?: null

    Can only be null. Used to disassociate request from any Window.

    Settings

    Member Visibility

    On This Page

    Properties