Lelantos SDK

Appearance

@lelantos-org/sdk / services / HttpRequestInit

Interface: HttpRequestInit ​

Defined in: @lelantos-org/sdk/dist/services/http/client.d.ts:50

RequestInit plus the transport's own per-request switches.

Extends ​

  • RequestInit

Properties ​

body? ​

ts
optional body?: BodyInit | null;

Defined in: typescript/lib/lib.dom.d.ts:1861

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

Inherited from ​

ts
RequestInit.body

cache? ​

ts
optional cache?: RequestCache;

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

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

Inherited from ​

ts
RequestInit.cache

credentials? ​

ts
optional credentials?: RequestCredentials;

Defined in: 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 ​

ts
RequestInit.credentials

headers? ​

ts
optional headers?: HeadersInit;

Defined in: typescript/lib/lib.dom.d.ts:1867

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

Inherited from ​

ts
RequestInit.headers

idempotent? ​

ts
optional idempotent?: boolean;

Defined in: @lelantos-org/sdk/dist/services/http/client.d.ts:57

Whether repeating the request is harmless. Defaults to true for GET, HEAD and OPTIONS and false otherwise. Decides the retry policy, the timeout (timeoutMs vs submitTimeoutMs) and whether an Idempotency-Key is attached. Never sent on the wire.

integrity? ​

ts
optional integrity?: string;

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

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

Inherited from ​

ts
RequestInit.integrity

keepalive? ​

ts
optional keepalive?: boolean;

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

A boolean to set request's keepalive.

Inherited from ​

ts
RequestInit.keepalive

method? ​

ts
optional method?: string;

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

A string to set request's method.

Inherited from ​

ts
RequestInit.method

mode? ​

ts
optional mode?: RequestMode;

Defined in: 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 ​

ts
RequestInit.mode

priority? ​

ts
optional priority?: RequestPriority;

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

Inherited from ​

ts
RequestInit.priority

redirect? ​

ts
optional redirect?: RequestRedirect;

Defined in: 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 ​

ts
RequestInit.redirect

referrer? ​

ts
optional referrer?: string;

Defined in: 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 ​

ts
RequestInit.referrer

referrerPolicy? ​

ts
optional referrerPolicy?: ReferrerPolicy;

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

A referrer policy to set request's referrerPolicy.

Inherited from ​

ts
RequestInit.referrerPolicy

signal? ​

ts
optional signal?: AbortSignal | null;

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

An AbortSignal to set request's signal.

Inherited from ​

ts
RequestInit.signal

window? ​

ts
optional window?: null;

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

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

Inherited from ​

ts
RequestInit.window