Documentation / @warp-drive/core / types/request / RequestInfo

Interface: RequestInfo<RT>

Defined in: core/src/types/request.ts:334

Extends JavaScript's native fetch NativeRequestInit | RequestInit with additional properties specific to the RequestManager's capabilities.

This interface is used to define the shape of a request that can be made via either the RequestManager.request or Store.request methods.

Since

4.12

Extends

• NativeRequestInit

Type Parameters

RT

RT = unknown

Properties

___(unique) Symbol(EnableHydration)?

optional ___(unique) Symbol(EnableHydration): boolean;

Defined in: core/src/types/request.ts:376

---

___(unique) Symbol(RequestSignature)?

optional ___(unique) Symbol(RequestSignature): RT;

Defined in: core/src/types/request.ts:374

---

body?

optional body: null | BodyInit;

Defined in: core/src/types/request.ts:302

Any body that you want to add to your request. Note that a GET or HEAD request may not have a body.

Inherited from

NativeRequestInit.body

---

cache?

optional cache: RequestCache;

Defined in: core/src/types/request.ts:256

Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.

Inherited from

NativeRequestInit.cache

---

cacheOptions?

optional cacheOptions: CacheOptions;

Defined in: core/src/types/request.ts:344

See

CacheOptions

---

controller?

optional controller: AbortController;

Defined in: core/src/types/request.ts:339

If provided, used instead of the AbortController auto-configured for each request by the RequestManager

---

credentials?

optional credentials: RequestCredentials;

Defined in: core/src/types/request.ts:259

Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.

Inherited from

NativeRequestInit.credentials

---

data?

optional data: Record<string, unknown>;

Defined in: core/src/types/request.ts:366

data that a handler should convert into the query (GET) or body (POST).

Note: It is recommended that builders set query params and body directly in most scenarios.

---

destination?

optional destination: RequestDestination;

Defined in: core/src/types/request.ts:262

Returns the kind of resource requested by request, e.g., "document" or "script".

Inherited from

NativeRequestInit.destination

---

disableTestWaiter?

optional disableTestWaiter: boolean;

Defined in: core/src/types/request.ts:357

---

duplex?

optional duplex: "half";

Defined in: core/src/types/request.ts:311

When sending a ReadableStream as the body of a request, 'half' must be specified.

Half Duplex Further Reading

Inherited from

NativeRequestInit.duplex

---

headers?

optional headers: Headers;

Defined in: core/src/types/request.ts:265

Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.

Inherited from

NativeRequestInit.headers

---

integrity?

optional integrity: string;

Defined in: core/src/types/request.ts:268

Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]

Inherited from

NativeRequestInit.integrity

---

keepalive?

optional keepalive: boolean;

Defined in: core/src/types/request.ts:271

Returns a boolean indicating whether or not request can outlive the global in which it was created.

Inherited from

NativeRequestInit.keepalive

---

method?

optional method: HTTPMethod;

Defined in: core/src/types/request.ts:274

Returns request's HTTP method, which is "GET" by default.

Inherited from

NativeRequestInit.method

---

mode?

optional mode: RequestMode;

Defined in: core/src/types/request.ts:280

Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.

no-cors is not allowed for streaming request bodies.

Inherited from

NativeRequestInit.mode

---

op?

optional op: string;

Defined in: core/src/types/request.ts:347

---

options?

optional options: Record<string, unknown>;

Defined in: core/src/types/request.ts:372

options specifically intended for Handlers to utilize to process the request

---

priority?

optional priority: RequestPriority;

Defined in: core/src/types/request.ts:284

provides an explicit priority hint for the request.

Inherited from

NativeRequestInit.priority

---

records?

optional records: ResourceKey[];

Defined in: core/src/types/request.ts:355

The ResourceKeys of the primary resources involved in the request (if any). This may be used by handlers to perform transactional operations on the store.

---

redirect?

optional redirect: RequestRedirect;

Defined in: core/src/types/request.ts:287

Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.

Inherited from

NativeRequestInit.redirect

---

referrer?

optional referrer: string;

Defined in: core/src/types/request.ts:290

Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the Referer header of the request being made.

Inherited from

NativeRequestInit.referrer

---

referrerPolicy?

optional referrerPolicy: ReferrerPolicy;

Defined in: core/src/types/request.ts:293

Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.

Inherited from

NativeRequestInit.referrerPolicy

---

signal?

optional signal: AbortSignal;

Defined in: core/src/types/request.ts:296

Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.

Inherited from

NativeRequestInit.signal

---

store?

optional store: Store;

Defined in: core/src/types/request.ts:345

---

url?

optional url: string;

Defined in: core/src/types/request.ts:299

Returns the URL of request as a string.

Inherited from

NativeRequestInit.url