IrohHttpFetchInit

Per-request controls understood by an iroh-http/2 Fetch implementation.

Extends

RequestInit

Properties

body?

optional body?: BodyInit | null;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2554

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

Inherited from

RequestInit.body

cache?

optional cache?: RequestCache;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2556

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

Inherited from

RequestInit.cache

credentials?

optional credentials?: RequestCredentials;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2558

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

RequestInit.credentials

decompress?

optional decompress?: boolean;

Defined in: src/client/httpi.ts:22

Preserve wire Content-Encoding for VGI’s HTTP codec.

directAddrs?

optional directAddrs?: string[];

Defined in: src/client/httpi.ts:16

Known direct QUIC addresses for the remote endpoint.

headers?

optional headers?: HeadersInit;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2560

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

Inherited from

RequestInit.headers

integrity?

optional integrity?: string;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2562

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

Inherited from

RequestInit.integrity

keepalive?

optional keepalive?: boolean;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2564

A boolean to set request’s keepalive.

Inherited from

RequestInit.keepalive

maxResponseBodyBytes?

optional maxResponseBodyBytes?: number;

Defined in: src/client/httpi.ts:24

Maximum response bytes buffered/read by the native adapter.

method?

optional method?: string;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2566

A string to set request’s method.

Inherited from

RequestInit.method

mode?

optional mode?: RequestMode;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2568

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

Inherited from

RequestInit.mode

priority?

optional priority?: RequestPriority;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2569

Inherited from

RequestInit.priority

redirect?

optional redirect?: RequestRedirect;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2571

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

RequestInit.redirect

referrer?

optional referrer?: string;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2573

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

Inherited from

RequestInit.referrer

referrerPolicy?

optional referrerPolicy?: ReferrerPolicy;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2575

A referrer policy to set request’s referrerPolicy.

Inherited from

RequestInit.referrerPolicy

relayUrl?

optional relayUrl?: string;

Defined in: src/client/httpi.ts:18

Known home-relay URL for the remote endpoint.

requestTimeout?

optional requestTimeout?: number;

Defined in: src/client/httpi.ts:20

Complete iroh-http request deadline in milliseconds.

signal?

optional signal?: AbortSignal | null;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2577

An AbortSignal to set request’s signal.

Inherited from

IrohHttpFetchInit.signal

window?

optional window?: null;

Defined in: docs/node_modules/typescript/lib/lib.dom.d.ts:2579

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

Inherited from

RequestInit.window