Skip to main content

Interface: RequestOptions

@sapphire/fetch.RequestOptions

Hierarchy​

  • Omit<RequestInit, "body">

    ↳ RequestOptions

Properties​

body​

• Optional body: BodyInit | Record<any, any>

Defined in​

projects/utilities/packages/fetch/src/lib/types.ts:267

cache​

• Optional cache: RequestCache

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

Inherited from​

Omit.cache

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1614

credentials​

• Optional 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.

Inherited from​

Omit.credentials

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1616

headers​

• Optional headers: HeadersInit

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

Inherited from​

Omit.headers

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1618

integrity​

• Optional integrity: string

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

Inherited from​

Omit.integrity

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1620

keepalive​

• Optional keepalive: boolean

A boolean to set request's keepalive.

Inherited from​

Omit.keepalive

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1622

method​

• Optional method: string

A string to set request's method.

Inherited from​

Omit.method

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1624

mode​

• Optional mode: RequestMode

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

Inherited from​

Omit.mode

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1626

redirect​

• Optional 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.

Inherited from​

Omit.redirect

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1628

referrer​

• Optional referrer: string

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

Inherited from​

Omit.referrer

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1630

referrerPolicy​

• Optional referrerPolicy: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

Inherited from​

Omit.referrerPolicy

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1632

signal​

• Optional signal: null | AbortSignal

An AbortSignal to set request's signal.

Inherited from​

Omit.signal

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1634

window​

• Optional window: null

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

Inherited from​

Omit.window

Defined in​

node_modules/typescript/lib/lib.dom.d.ts:1636