W-CF Documentation - v11.0.0
    Preparing search index...

    Interface FetchOptions

    interface FetchOptions {
        abortController?: AbortController;
        body?: BodyInit | null;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        headers?: HeadersInit;
        ignoreGlobalErrorHandler?: boolean;
        integrity?: string;
        keepalive?: boolean;
        method?: string;
        mode?: RequestMode;
        onGetResponseError?: (pResponse: Response) => Promise<Error | null>;
        onGetRetryDelay?: (pRetryCount: number) => number;
        priority?: RequestPriority;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        retryAttempts?: number;
        signal?: AbortSignal | null;
        timeout?: number | null;
        window?: null;
    }

    Hierarchy (View Summary)

    Index
    abortController?: AbortController

    Custom abort controller which can be used to abort the request. This abort cotroller will also be used for the timeout handling. If you want to use a custom timeout handling the signal option should be used instead. Note: If the signal option is specified this option will be ignored.

    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.

    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.

    headers?: HeadersInit

    A Headers object, an object literal, or an array of two-item arrays to set request's headers.

    ignoreGlobalErrorHandler?: boolean

    if true the global fetchErrorHandler will not be triggered in case of an error (default: false)

    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.

    onGetResponseError?: (pResponse: Response) => Promise<Error | null>

    Can be used to return a custom error.

    onGetRetryDelay?: (pRetryCount: number) => number

    Can be used to define a custom delay for the retry attempts.

    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.

    retryAttempts?: number

    defines how many automatic retry attempts will be performed in case of connection errors (default: 3)

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.

    timeout?: number | null

    The timeout for the request in ms (default: 30000) In case of timeout a DOMException - TimeoutError will be thrown. Note: If the signal option is specified the timeout handling will be disabled.

    window?: null

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