Documentation
    Preparing search index...

    Additional options for the fetch function.

    Almost same with RequestInit type of the fetch function, but body, headers and method properties are omitted.

    The explicit option record exposes the supported subset independently of changes to RequestInit. DOM types are still required by the connection's custom fetch and abort signal members.

    contracts/common.md#principled-implementation The record exposes a subset of RequestInit options while omitting body, headers and method, whose construction belongs to the route pipeline; AbortSignal and the connection's fetch member still depend on DOM declarations.

    contracts/common.md#clear-and-simple-design A flat option record, with each member mirroring one field of the standard request options.

    contracts/common.md#prohibited-implementation-shortcuts It is a type; the fetcher spreads the options into the request and then sets the method and headers itself.

    contracts/common.md#meaningful-documentation The comment explains the supported subset and remaining DOM type dependency, and each member documents the standard field's meaning.

    interface IOptions {
        cache?:
            | "default"
            | "force-cache"
            | "no-cache"
            | "no-store"
            | "only-if-cached"
            | "reload";
        credentials?: "omit"
        | "same-origin"
        | "include";
        integrity?: string;
        keepalive?: boolean;
        mode?: "same-origin" | "cors" | "navigate" | "no-cors";
        redirect?: "error" | "follow" | "manual";
        referrer?: string;
        referrerPolicy?:
            | ""
            | "same-origin"
            | "no-referrer"
            | "no-referrer-when-downgrade"
            | "origin"
            | "origin-when-cross-origin"
            | "strict-origin"
            | "strict-origin-when-cross-origin"
            | "unsafe-url";
        signal?: AbortSignal
        | null;
    }
    Index
    cache?:
        | "default"
        | "force-cache"
        | "no-cache"
        | "no-store"
        | "only-if-cached"
        | "reload"

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

    credentials?: "omit" | "same-origin" | "include"

    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.

    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.

    mode?: "same-origin" | "cors" | "navigate" | "no-cors"

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

    Sets request's mode.

    redirect?: "error" | "follow" | "manual"

    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?:
        | ""
        | "same-origin"
        | "no-referrer"
        | "no-referrer-when-downgrade"
        | "origin"
        | "origin-when-cross-origin"
        | "strict-origin"
        | "strict-origin-when-cross-origin"
        | "unsafe-url"

    A referrer policy to set request's referrerPolicy.

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.