JavaScript Request : Object

constructor

Request is used to describe an request to a server. Use with fetch() to perform the request and get a Response. Request, fetch(), and Response are a new, low level replacement for XMLHttpRequest.

Spec

Constructors

new Request(url : String, [init : Object]) : Request

init : {

body	Object	The data to send with the request. Must be a Blob, BufferSource, FormData, String, or URLSearchParams.
cache	String	See the cache property for the valid values.
credentials	String	See the credentials property for the valid values.
headers	Object	The http headers to send with the request. This will be passed to the Headers constructor.
integrity	String
keepalive	Boolean
method	String	The http method such as `'GET'`, `'POST'`, `'DELETE'`.
mode	String	See the mode property for the valid values.
redirect	String	One of `'follow'`, `'error'`, or `'manual'`
referrer	String
referrerPolicy	String	One of `''`, `'no-referrer'`, `'no-referrer-when-downgrade'`, `'same-origin'`, `'origin'`, `'strict-origin'`, `'origin-when-cross-origin'`, `'strict-origin-when-cross-origin'`, or `'unsafe-url'`
requestMode	String	One of `'navigate'`, `'same-origin'`, `'no-cors'`, or `'cors'`
requestCredentials	String	One of `'omit'`, `'same-origin'`, or `'include'`
signal	AbortSignal

}

Example:

var request = new Request('/');
fetch(request).then(function(response) {
  return response.text();
}).then(function(text) {
  console.log(text.substring(0, 30));
});

Run

Results:

new Request(request : Request, [init : Object]) : Request

Instance Properties

bodyUsed : Boolean readonly

cache : String readonly

Will be one of: 'default', 'force-cache', 'no-cache', 'no-store', 'only-if-cached', 'reload'.

credentials : String readonly

Will be one of: 'include', 'omit', 'same-origin'.

destination : String readonly

Will be one of: '', 'audio', 'audioworklet', 'document', 'embed', 'font', 'frame', 'iframe', 'image', 'manifest', 'object', 'paintworklet', 'report', 'script', 'sharedworker', 'style', 'track', 'video', 'worker', 'xslt'.

headers : Headers readonly

integrity : String readonly

isHistoryNavigation : Boolean readonly

isReloadNavigation : Boolean readonly

keepalive : Boolean readonly

method : String readonly

mode : String readonly

Will be one of: 'same-origin', 'no-cors', 'cors'.

redirect : String readonly

referrer : String readonly

referrerPolicy : String readonly

signal : AbortSignal readonly

url : String readonly

Instance Methods

arrayBuffer() : Promise<ArrayBuffer>

Returns a Promise to the body of the request as an ArrayBuffer.

Example:

var request = new Request('/', {
  method: 'POST',
  body: 'text to send to server' 
});

request.arrayBuffer().then(function(arrayBuffer) {
  var uint8Array = new Uint8Array(arrayBuffer);
  for (var i = 0; i < uint8Array.length; i++) {
    console.log(String.fromCharCode(uint8Array[i]));
  }
});

Run

Results:

blob() : Promise<Blob>

Returns a Promise to the body of the request as a Blob.

Example:

var request = new Request('/', {
  method: 'POST',
  body: 'text to send to server' 
});

request.blob().then(function(blob) {
  var reader = new FileReader();

  reader.onload = function() {
    console.log(reader.result);
  };

  reader.readAsText(blob);
});

Run

Results:

clone() : Request

formData() : Promise<FormData>

Returns a Promise to the body of the request as a FormData.

json() : Promise<Object>

Parses the body of the request and returns a Promise with the result.

Example:

var request = new Request('/', {
  method: 'POST',
  body: '{ "foo": "1", "bar": 2 }' 
});

request.json().then(function(json) { 
  console.log(json.foo);
  console.log(json.bar);
});

Run

Results:

text() : Promise<String>

Returns a Promise to the body of the request.

Example:

var request = new Request('/', {
  method: 'POST',
  body: 'text to send to server' 
});

request.text().then(function(text) { 
  console.log(text);
});

Run

Results:

home license contribute feedback