Mande
    Preparing search index...

    Interface Options<ResponseAs>

    Allowed options for a request. Extends native RequestInit.

    interface Options<ResponseAs extends ResponseAsTypes = ResponseAsTypes> {
        body?: BodyInit | null;
        cache?: RequestCache;
        credentials?: RequestCredentials;
        headers?: Record<string, string>;
        integrity?: string;
        keepalive?: boolean;
        method?: string;
        mode?: RequestMode;
        priority?: RequestPriority;
        query?: any;
        redirect?: RequestRedirect;
        referrer?: string;
        referrerPolicy?: ReferrerPolicy;
        responseAs?: ResponseAs;
        signal?: AbortSignal | null;
        stringify?: (data: unknown) => string;
        window?: null;
    }

    Type Parameters

    Hierarchy

    • RequestInit
      • Options
    Index

    Properties

    body? cache? credentials? headers? integrity? keepalive? method? mode? priority? query? redirect? referrer? referrerPolicy? responseAs? signal? stringify? window?

    Properties

    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.

    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?: Record<string, string>

    Headers sent alongside the request

    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.

    priority?: RequestPriority
    query?: any

    Optional query object. Does not support arrays. Will get stringified

    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.

    responseAs?: ResponseAs

    What kind of response is expected. Defaults to json. response will return the raw response from fetch.

    signal?: AbortSignal | null

    An AbortSignal to set request's signal.

    stringify?: (data: unknown) => string

    Optional function to stringify the body of the request for POST and PUT requests. Defaults to JSON.stringify.

    window?: null

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

    Settings

    Member Visibility

    On This Page

    Properties