Request extension type

The Request interface of the Fetch API represents a resource request.

You can create a new Request object using the Request.Request constructor, but you are more likely to encounter a Request object being returned as the result of another API operation, such as a service worker FetchEvent.request.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

Request(RequestInfo input, [RequestInit init])
factory

Properties

body → ReadableStream?
The read-only body property of the Request interface contains a ReadableStream with the body contents that have been added to the request. Note that a request using the GET or HEAD method cannot have a body and null is returned in these cases.
no setter
bodyUsed → bool
The read-only bodyUsed property of the Request interface is a boolean value that indicates whether the request body has been read yet.
no setter
cache → RequestCache
The cache read-only property of the Request interface contains the cache mode of the request. It controls how the request will interact with the browser's HTTP cache.
no setter
credentials → RequestCredentials
The credentials read-only property of the Request interface indicates whether the user agent should send or receive cookies from the other domain in the case of cross-origin requests.
no setter
destination → RequestDestination
The destination read-only property of the Request interface returns a string describing the type of content being requested.
no setter
hashCode → int
The hash code for this object.
no setterinherited
headers → Headers
The headers read-only property of the Request interface contains the Headers object associated with the request.
no setter
integrity → String
The integrity read-only property of the Request interface contains the subresource integrity value of the request.
no setter
isHistoryNavigation → bool
no setter
keepalive → bool
no setter
method → String
The method read-only property of the Request interface contains the request's method (GET, POST, etc.)
no setter
mode → RequestMode
The mode read-only property of the Request interface contains the mode of the request (e.g., cors, no-cors, same-origin, navigate or websocket.) This is used to determine if cross-origin requests lead to valid responses, and which properties of the response are readable.
no setter
redirect → RequestRedirect
The redirect read-only property of the Request interface contains the mode for how redirects are handled.
no setter
referrer → String
The referrer read-only property of the Request interface is set by the user agent to be the referrer of the Request. (e.g., client, no-referrer, or a URL.)
no setter
referrerPolicy → ReferrerPolicy
The referrerPolicy read-only property of the Request interface returns the referrer policy, which governs what referrer information, sent in the Referer header, should be included with the request.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
signal → AbortSignal
The read-only signal property of the Request interface returns the AbortSignal associated with the request.
no setter
url → String
The url read-only property of the Request interface contains the URL of the request.
no setter

Methods

arrayBuffer() → JSPromise<JSArrayBuffer>
The arrayBuffer() method of the Request interface reads the request body and returns it as a promise that resolves with an ArrayBuffer.
blob() → JSPromise<Blob>
The blob() method of the Request interface reads the request body and returns it as a promise that resolves with a Blob.
bytes() → JSPromise<JSUint8Array>
The bytes() method of the Request interface reads the request body and returns it as a promise that resolves with an Uint8Array.
clone() → Request
The clone() method of the Request interface creates a copy of the current Request object.
formData() → JSPromise<FormData>
The formData() method of the Request interface reads the request body and returns it as a promise that resolves with a FormData object.
json() → JSPromise<JSAny?>
The json() method of the Request interface reads the request body and returns it as a promise that resolves with the result of parsing the body text as JSON.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
text() → JSPromise<JSString>
The text() method of the Request interface reads the request body and returns it as a promise that resolves with a String. The response is always decoded using UTF-8.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited