Request

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.

Constructor

Request.Request()

Creates a new Request object.

Properties

Request.method Read only

Contains the request's method (GET, POST, etc.)

Request.url Read only

Contains the URL of the request.

Request.headers Read only

Contains the associated Headers object of the request.

Request.context Read only  

Contains the context of the request (e.g., audio, image, iframe, etc.)

Request.referrer Read only

Contains the referrer of the request (e.g., client).

Request.mode Read only

Contains the mode of the request (e.g., cors, no-cors, same-origin).

Request.credentials Read only

Contains the credentials of the request (e.g., omit, same-origin).

Request.integrity Read only

Contains the subresource integrity value of the request (e.g., sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE=).

Request.cache Read only

Contains the cache mode of the request (e.g., default, reload, no-cache).

Request implements Body, so it also has the following property available to it:

Body.bodyUsed Read only

Stores a Boolean that declares whether the body has been used in a response yet.

Methods

Request.clone()

Creates a copy of the current Request object.

Request implements Body, so it also has the following methods available to it:

Body.arrayBuffer()

Takes a Response stream and reads it to completion. It returns a promise that resolves with an ArrayBuffer.

Body.blob()

Takes a Response stream and reads it to completion. It returns a promise that resolves with a Blob.

Body.formData()

Takes a Response stream and reads it to completion. It returns a promise that resolves with a FormData object.

Body.json()

Takes a Response stream and reads it to completion. It returns a promise that resolves with a JSON object.

Body.text()

Takes a Response stream and reads it to completion. It returns a promise that resolves with a USVString (text).

Examples

In the following snippet, we create a new request using the Request() constructor (for an image file in the same directory as the script), then return some property values of the request:

var myRequest = new Request('flowers.jpg');

var myURL = myRequest.url; // http://localhost:8000/flowers.jpg
var myMethod = myRequest.method; // GET
var myCred = myRequest.credentials; // omit

You could then fetch this request by passing the Request object in as a parameter to a GlobalFetch.fetch() call, for example:

fetch(myRequest).then(function(response) {
      return response.blob();
    }).then(function(response) {
      var objectURL = URL.createObjectURL(response);
      myImage.src = objectURL;
    });

Specifications

Browser compatibility

[1] This feature is implemented behind a preference.

See also

• ServiceWorker API
• HTTP access control (CORS)
• HTTP