Optional
blockingOptional
bodyDefault: null
Optional
bodyThe timeout after which a request will time out, in milliseconds. Monitors time between receiving body data. Use 0 to disable it entirely. Defaults to 300 seconds.
Optional
expectFor H2, it appends the expect: 100-continue header, and halts the request body until a 100-continue is received from the remote server
Optional
headersDefault: null
Optional
headersThe amount of time, in milliseconds, the parser will wait to receive the complete HTTP headers. Defaults to 300 seconds.
Optional
highDefault: 64 KiB
Optional
idempotentWhether the requests can be safely retried or not. If false
the request won't be sent until all preceding requests in the pipeline have completed. Default: true
if method
is HEAD
or GET
.
Optional
maxDefault: 0
Optional
objecttrue
if the handler
will return an object stream. Default: false
Optional
onOptional
opaqueDefault: null
Optional
originOptional
queryQuery string params to be embedded in the request URL. Default: null
Optional
resetWhether the request should stablish a keep-alive or not. Default false
Optional
responseDefault: null
Optional
signalDefault: null
Optional
throwWhether Undici should throw an error upon receiving a 4xx or 5xx response from the server. Defaults to false
Optional
upgradeUpgrade the request. Should be used to specify the kind of upgrade i.e. 'Websocket'
. Default: method === 'CONNECT' || null
.
Generated using TypeDoc
Whether the response is expected to take a long time and would end up blocking the pipeline. When this is set to
true
further pipelining will be avoided on the same connection until headers have been received.