The Request()
constructor creates a new Request
object.
The Request()
constructor creates a new Request
object.
new Request(input) new Request(input, options)
input
Defines the resource that you wish to fetch. This can either be:
baseURI
in a window context, or WorkerGlobalScope.location
in a worker context.Request
object, effectively creating a copy. Note the following behavioral updates to retain security while making the constructor less likely to throw exceptions: Request.referrer
is stripped out. Request.mode
of navigate
, the mode
value is converted to same-origin
. options
Optional
An object containing any custom settings that you want to apply to the request. The possible options are:
method
The request method, e.g., GET
, POST
. The default is GET
.
headers
Any headers you want to add to your request, contained within a Headers
object or an object literal with String
values.
body
Any body that you want to add to your request: this can be a Blob
, an ArrayBuffer
, a TypedArray
, a DataView
, a FormData
, a URLSearchParams
, a string, or a ReadableStream
object. Note that a request using the GET
or HEAD
method cannot have a body.
mode
The mode you want to use for the request, e.g., cors
, no-cors
, same-origin
, or navigate
. The default is cors
.
credentials
The request credentials you want to use for the request: omit
, same-origin
, or include
. The default is same-origin
.
cache
The cache mode you want to use for the request.
redirect
The redirect mode to use: follow
, error
, or manual
. The default is follow
.
referrer
A string specifying no-referrer
, client
, or a URL. The default is about:client
.
referrerPolicy
A string that changes how the referrer header is populated during certain actions (e.g., fetching subresources, prefetching, performing navigations).
integrity
Contains the subresource integrity value of the request (e.g., sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE=
).
keepalive
A boolean that indicates whether to make a persistent connection for multiple requests/responses.
signal
An AbortSignal object which can be used to communicate with/abort a request.
priority
Specifies the priority of the fetch request relative to other requests of the same type. Must be one of the following strings:
high
: A high priority fetch request relative to other requests of the same type.low
: A low priority fetch request relative to other requests of the same type.auto
: Automatically determine the priority of the fetch request relative to other requests of the same type (default).If you construct a new Request
from an existing Request
, any options you set in an options argument for the new request replace any corresponding options set in the original Request
. For example:
const oldRequest = new Request( "https://github.com/mdn/content/issues/12959", { headers: { From: "[email protected]" } } ); oldRequest.headers.get("From"); // "[email protected]" const newRequest = new Request(oldRequest, { headers: { From: "[email protected]" }, }); newRequest.headers.get("From"); // "[email protected]"
Type | Description |
---|---|
TypeError | Since Firefox 43, Request() will throw a TypeError if the URL has credentials, such as http://user:[email protected]. |
In our Fetch Request example (see Fetch Request live) we create a new Request
object using the constructor, then fetch it using a fetch()
call. Since we are fetching an image, we run Response.blob
on the response to give it the proper MIME type so it will be handled properly, then create an Object URL of it and display it in an <img>
element.
const myImage = document.querySelector("img"); const myRequest = new Request("flowers.jpg"); fetch(myRequest) .then((response) => response.blob()) .then((response) => { const objectURL = URL.createObjectURL(response); myImage.src = objectURL; });
In our Fetch Request with init example (see Fetch Request init live) we do the same thing except that we pass in an options object when we invoke fetch()
:
const myImage = document.querySelector("img"); const myHeaders = new Headers(); myHeaders.append("Content-Type", "image/jpeg"); const myOptions = { method: "GET", headers: myHeaders, mode: "cors", cache: "default", }; const myRequest = new Request("flowers.jpg", myOptions); fetch(myRequest).then((response) => { // ... });
Note that you could also pass myOptions
into the fetch
call to get the same effect, e.g.:
fetch(myRequest, myOptions).then((response) => { // ... });
You can also use an object literal as headers
in myOptions
.
const myOptions = { method: "GET", headers: { "Content-Type": "image/jpeg", }, mode: "cors", cache: "default", }; const myRequest = new Request("flowers.jpg", myOptions);
You may also pass a Request
object to the Request()
constructor to create a copy of the Request (This is similar to calling the clone()
method.)
const copy = new Request(myRequest);
Note: This last usage is probably only useful in ServiceWorkers.
Specification |
---|
Fetch Standard # ref-for-dom-request① |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
Request |
40From Chrome 47, default values for theinit argument's properties changed. mode defaults to same-origin (from no-cors ). credentials defaults to include (from same-origin ). redirect defaults to follow (from manual ). |
14 | 39 | No | 27 | 10.1 | 40From Chrome 47, default values for theinit argument's properties changed. mode defaults to same-origin (from no-cors ). credentials defaults to include (from same-origin ). redirect defaults to follow (from manual ). |
40From Chrome 47, default values for theinit argument's properties changed. mode defaults to same-origin (from no-cors ). credentials defaults to include (from same-origin ). redirect defaults to follow (from manual ). |
39 | 27 | 10.3 | 4.0From Samsung Internet 5.0, default values for theinit argument's properties changed. mode defaults to same-origin (from no-cors ). credentials defaults to include (from same-origin ). redirect defaults to follow (from manual ). |
cross_origin_stripped |
69 | 15 | 54 | No | 56 | 10.1 | 69 | 69 | 54 | 48 | 10.3 | 10.0 |
init_referrer_parameter |
47 | 15 | 47 | No | 34 | 10.1 | 47 | 47 | 47 | 34 | 10.3 | 5.0 |
navigate_mode |
49 | 15 | 46 | No | 36 | 10.1 | No | 49 | 46 | No | 10.3 | 5.0 |
request_body_readablestream |
105 | 105 | No | No | 91 | No | 105 | 105 | No | 72 | No | 20.0 |
response_body_readablestream |
43 | ≤79 | 65 | No | 30 | No | 43 | 43 | 65 | No | 10.3 | 4.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Request/Request