Skip to main content

Interface: ImaRequestInit

Defined in: packages/core/src/http/HttpAgent.ts:26

Options for a request sent using the HTTP agent.

Extends​

  • Omit<RequestInit, "body">

Properties​

cache?​

optional cache: RequestCache

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1863

Flag that enables caching the HTTP request (enabled by default, also applies to requests in progress).

Inherited from​

Omit.cache

credentials?​

optional credentials: RequestCredentials

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1865

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

headers?​

optional headers: Record<string, string>

Defined in: packages/core/src/http/HttpAgent.ts:27

Sets the additional request headers (the keys are case-insensitive header names, the values are header values).

Overrides​

Omit.headers

integrity?​

optional integrity: string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1869

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

Inherited from​

Omit.integrity

keepalive?​

optional keepalive: boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1871

A boolean to set request's keepalive.

Inherited from​

Omit.keepalive

method?​

optional method: string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1873

A string to set request's method.

Inherited from​

Omit.method

mode?​

optional mode: RequestMode

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1875

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

priority?​

optional priority: RequestPriority

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1876

Inherited from​

Omit.priority

redirect?​

optional redirect: RequestRedirect

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1878

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

referrer?​

optional referrer: string

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1880

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

Inherited from​

Omit.referrer

referrerPolicy?​

optional referrerPolicy: ReferrerPolicy

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1882

A referrer policy to set request's referrerPolicy.

Inherited from​

Omit.referrerPolicy

signal?​

optional signal: null | AbortSignal

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1884

An AbortSignal to set request's signal.

Inherited from​

Omit.signal

window?​

optional window: null

Defined in: node_modules/typescript/lib/lib.dom.d.ts:1886

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

Inherited from​

Omit.window