interface FullRequestParams {
    baseUrl?: string;
    body?: unknown;
    cache?: RequestCache;
    cancelToken?: CancelToken;
    credentials?: RequestCredentials;
    format?:
        | "formData"
        | "text"
        | "blob"
        | "json"
        | "arrayBuffer";
    headers?: HeadersInit;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    path: string;
    priority?: RequestPriority;
    query?: QueryParamsType;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    secure?: boolean;
    signal?: null | AbortSignal;
    type?: ContentType;
    window?: null;
}

Hierarchy

  • Omit<RequestInit, "body">
    • FullRequestParams

Properties

baseUrl?: string

base url

body?: unknown

request body

cache?: RequestCache

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

cancelToken?: CancelToken

request cancellation token

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.

format?:
    | "formData"
    | "text"
    | "blob"
    | "json"
    | "arrayBuffer"

format of response (i.e. response.json() -> format: "json")

headers?: HeadersInit

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

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.

path: string

request path

priority?: RequestPriority

query params

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.

secure?: boolean

set parameter to true for call securityWorker for this request

signal?: null | AbortSignal

An AbortSignal to set request's signal.

content type of request body

window

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