Interface RequestInit

interface RequestInit {
    body?: null | string | ReadableStream<any> | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams;
    cache?: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
    credentials?: "include" | "omit" | "same-origin";
    headers?: [string, string][] | Record<string, string> | Headers;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    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?: null | AbortSignal;
    window?: null;
}

Properties

body? cache? credentials? headers? integrity? keepalive? method? mode? redirect? referrer? referrerPolicy? signal? window?

Properties

Optional body

body?: null | string | ReadableStream<any> | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams

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

Optional cache

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.

Optional credentials

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

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

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

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?: "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.

Optional redirect

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.

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?: "" | "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.

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optional window

window?: null

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc