Request() | @fastly/js-compute (original) (raw)
- globals
- Request()
Version: 3.34.0
The Request()
constructor creates a newRequest
object.
Syntax
new Request(input)
new Request(input, options)
Parameters
input
- : Defines the resource that you wish to fetch. This can either be:
* A string containing the direct URL of the resource you want to fetch.
* ARequest
object, effectively creating a copy.
- : Defines the resource that you wish to fetch. This can either be:
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 isGET
.
*headers
* : Any headers you want to add to your request, contained within aHeaders
object or an object literal withString
values.
*body
* : Any body that you want to add to your request: this can be anArrayBuffer
, aTypedArray
, aDataView
, aURLSearchParams
, string object or literal, aReadableStream
object, a Blob object, or a FormData object.
*backend
Fastly-specific
*cacheOverride
Fastly-specific, see CacheOverride.
*cacheKey
Fastly-specific
*manualFramingHeaders
: boolean optional Fastly-specific
* : The default value isfalse
, which means that the framing headers are automatically created based on the message body. In "automatic" mode, aContent-Length
is used when the size of the body can be determined before it is sent. Requests sent in streaming mode, where headers are sent immediately but the content of the body is streamed later, will receive aTransfer-Encoding: chunked
to accommodate the dynamic generation of the body. In "manual" mode, anyContent-Length
orTransfer-Encoding
headers will be honored. You must ensure that those headers have correct values permitted by the HTTP/1.1 specification. If the provided headers are not permitted by the specification, the headers will revert to "automatic" mode and a diagnostic message will be logged about what was wrong. If aContent-Length
is permitted by the specification, but the value does not match the size of the actual body, the body will either be truncated (if it is too long), or the connection will be hung up early (if it is too short).
*fastly
Fastly-specific
*decompressGzip
: boolean optional
* Whether to automatically gzip decompress the Response or not.
- : An object containing any custom settings that you want to apply to the request. The possible options are: