Interface Options

interface Options {
    [ON_GLOBAL_DOWNLOAD_PROGRESS]?: ProgressCallback;
    baseURL?: string;
    body?: BodyInit | Record<string, any>;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    meta?: Record<string, any>;
    method?: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "PATCH";
    mode?: RequestMode;
    onDownloadProgress?: ProgressCallback;
    params?: Record<string, any>;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    responseType?: ResponseType;
    signal?: null | AbortSignal;
    throwHttpError?: boolean;
    timeout?: number;
    url?: string;
    window?: null;
}

Hierarchy

Properties

[ON_GLOBAL_DOWNLOAD_PROGRESS]? baseURL? body? cache? credentials? headers? integrity? keepalive? meta? method? mode? onDownloadProgress? params? redirect? referrer? referrerPolicy? responseType? signal? throwHttpError? timeout? url? window?

Properties

Optional [ON_GLOBAL_DOWNLOAD_PROGRESS]

[ON_GLOBAL_DOWNLOAD_PROGRESS]?: ProgressCallback

Optional baseURL

baseURL?: string

Optional body

body?: BodyInit | Record<string, any>

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?: HeadersInit

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 meta

meta?: Record<string, any>

Optional method

method?: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "PATCH"

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 onDownloadProgress

onDownloadProgress?: ProgressCallback

Optional params

params?: Record<string, any>

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 responseType

responseType?: ResponseType

This should be consistent with the parsing method of Response

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optional throwHttpError

throwHttpError?: boolean

Optional timeout

timeout?: number

Optional url

url?: string

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