Interface HttpOptions

interface HttpOptions {
    baseURL?: string;
    body?: null | BodyInit;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
    headers: Headers;
    hooks?: Partial<
        Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>,
    >[];
    info?: IStorage;
    integrity?: string;
    json?: unknown;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    parseJson?: (text: string) => unknown;
    parseTypedJson?: (text: string, useTypedField?: boolean) => unknown;
    priority?: RequestPriority;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    removeEmptySearchParamsValue?: boolean;
    searchParams?: HttpSearchParams;
    signal?: null | AbortSignal;
    stringifyJson?: (obj: unknown) => string;
    stringifyTypedJson?: (obj: unknown) => string;
    throwHttpErrors?: boolean;
    throwOnEmptyJson?: boolean;
    timeout?: number;
    treat404As204?: boolean;
    typedJson?: unknown;
    window?: null;
}

Hierarchy (View Summary, Expand)

Properties

baseURL? body? cache? credentials? fetch? headers hooks? info? integrity? json? keepalive? method? mode? parseJson? parseTypedJson? priority? redirect? referrer? referrerPolicy? removeEmptySearchParamsValue? searchParams? signal? stringifyJson? stringifyTypedJson? throwHttpErrors? throwOnEmptyJson? timeout? treat404As204? typedJson? window?

Properties

OptionalbaseURL

baseURL?: string

Optionalbody

body?: null | BodyInit

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

Optionalcache

cache?: RequestCache

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

Optionalcredentials

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.

Optionalfetch

fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>

headers

headers: Headers

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

Optionalhooks

hooks?: Partial<
    Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>,
>[]

Optionalinfo

info?: IStorage

Optionalintegrity

integrity?: string

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

Optionaljson

json?: unknown

Optionalkeepalive

keepalive?: boolean

A boolean to set request's keepalive.

Optionalmethod

method?: string

A string to set request's method.

Optionalmode

mode?: RequestMode

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

OptionalparseJson

parseJson?: (text: string) => unknown

OptionalparseTypedJson

parseTypedJson?: (text: string, useTypedField?: boolean) => unknown

Optionalpriority

priority?: RequestPriority

Optionalredirect

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.

Optionalreferrer

referrer?: string

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

OptionalreferrerPolicy

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

OptionalremoveEmptySearchParamsValue

removeEmptySearchParamsValue?: boolean

OptionalsearchParams

searchParams?: HttpSearchParams

Optionalsignal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

OptionalstringifyJson

stringifyJson?: (obj: unknown) => string

OptionalstringifyTypedJson

stringifyTypedJson?: (obj: unknown) => string

OptionalthrowHttpErrors

throwHttpErrors?: boolean

OptionalthrowOnEmptyJson

throwOnEmptyJson?: boolean

Optionaltimeout

timeout?: number

Optionaltreat404As204

treat404As204?: boolean

OptionaltypedJson

typedJson?: unknown

Optionalwindow

window?: null

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR