WebResourceLike interface
A description of a HTTP request to be made to a remote server.
Properties
| abort |
Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response. |
| body | The HTTP body contents of the request. |
| decompress |
Whether or not to decompress response according to Accept-Encoding header (node-fetch only) |
| form |
Form data, used to build the request body. |
| headers | The HTTP headers to use when making the request. |
| keep |
If the connection should be reused. |
| method | The HTTP method to use when making the request. |
| on |
Callback which fires upon download progress. |
| on |
Callback which fires upon upload progress. |
| operation |
A function that returns the proper OperationResponse for the given OperationSpec and HttpOperationResponse combination. If this is undefined, then a simple status code lookup will be used. |
| operation |
Used to parse the response. |
| proxy |
Proxy configuration. |
| query | A query string represented as an object. |
| request |
A unique identifier for the request. Used for logging and tracing. |
| should |
Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized. |
| stream |
Whether or not the body of the HttpOperationResponse should be treated as a stream. |
| stream |
A list of response status codes whose corresponding HttpOperationResponse body should be treated as a stream. |
| timeout | The number of milliseconds a request can take before automatically being terminated.
If the request is terminated, an |
| tracing |
Tracing: Context used when creating spans. |
| url | The URL being accessed by the request. |
| with |
If credentials (cookies) should be sent along during an XHR. |
Methods
| clone() | Clone this request object. |
| prepare(Request |
Sets options on the request. |
| validate |
Validates that the required properties such as method, url, headers["Content-Type"], headers["accept-language"] are defined. It will throw an error if one of the above mentioned properties are not defined. |
Property Details
abortSignal
Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.
abortSignal?: AbortSignalLikeProperty Value
body
The HTTP body contents of the request.
body?: anyProperty Value
any
decompressResponse
Whether or not to decompress response according to Accept-Encoding header (node-fetch only)
decompressResponse?: booleanProperty Value
boolean
formData
Form data, used to build the request body.
formData?: anyProperty Value
any
headers
The HTTP headers to use when making the request.
headers: HttpHeadersLikeProperty Value
keepAlive
If the connection should be reused.
keepAlive?: booleanProperty Value
boolean
method
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
operationResponseGetter
A function that returns the proper OperationResponse for the given OperationSpec and HttpOperationResponse combination. If this is undefined, then a simple status code lookup will be used.
operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponseProperty Value
(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse
operationSpec
proxySettings
query
A query string represented as an object.
query?: {[key: string]: any}Property Value
{[key: string]: any}
requestId
A unique identifier for the request. Used for logging and tracing.
requestId: stringProperty Value
string
shouldDeserialize
Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
shouldDeserialize?: boolean | (response: HttpOperationResponse) => booleanProperty Value
boolean | (response: HttpOperationResponse) => boolean
streamResponseBody
Warning
This API is now deprecated.
Use streamResponseStatusCodes property instead.
Whether or not the body of the HttpOperationResponse should be treated as a stream.
streamResponseBody?: booleanProperty Value
boolean
streamResponseStatusCodes
A list of response status codes whose corresponding HttpOperationResponse body should be treated as a stream.
streamResponseStatusCodes?: Set<number>Property Value
Set<number>
timeout
The number of milliseconds a request can take before automatically being terminated.
If the request is terminated, an AbortError is thrown.
timeout: numberProperty Value
number
tracingContext
Tracing: Context used when creating spans.
tracingContext?: ContextProperty Value
url
The URL being accessed by the request.
url: stringProperty Value
string
withCredentials
If credentials (cookies) should be sent along during an XHR.
withCredentials: booleanProperty Value
boolean
Method Details
clone()
prepare(RequestPrepareOptions)
Sets options on the request.
function prepare(options: RequestPrepareOptions): WebResourceLikeParameters
- options
- RequestPrepareOptions
Returns
validateRequestProperties()
Validates that the required properties such as method, url, headers["Content-Type"], headers["accept-language"] are defined. It will throw an error if one of the above mentioned properties are not defined.
function validateRequestProperties()