Interface Options<ResponseAs>

Allowed options for a request. Extends native RequestInit.

interface Options<ResponseAs> {
    body?: null | BodyInit;
    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?: null | AbortSignal;
    stringify?: ((data) => string);
    window?: null;
}

Type Parameters

Hierarchy

  • RequestInit
    • Options

Properties

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

Properties

Optional body

body?: null | BodyInit

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

Optional cache

cache?: RequestCache

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

Optional credentials

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.

Optional headers

headers?: Record<string, string>

Headers sent alongside the request

Optional integrity

integrity?: string

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

Optional keepalive

keepalive?: boolean

A boolean to set request's keepalive.

Optional method

method?: string

A string to set request's method.

Optional mode

mode?: RequestMode

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

Optional priority

priority?: RequestPriority

Optional query

query?: any

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

Optional redirect

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.

Optional referrer

referrer?: string

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

Optional referrerPolicy

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

Optional responseAs

responseAs?: ResponseAs

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

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optional stringify

stringify?: ((data) => string)

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

Type declaration

    • (data): string

    • Parameters

      • data: unknown

      Returns string

Optional window

window?: null

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

Settings

Member Visibility

Theme

On This Page

bodycachecredentialsheadersintegritykeepalivemethodmodepriorityqueryredirectreferrerreferrerPolicyresponseAssignalstringifywindow