WebResourceLike interface

Package:

@azure/core-http

A description of a HTTP request to be made to a remote server.

Properties

abortSignal	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.
decompressResponse	Whether or not to decompress response according to Accept-Encoding header (node-fetch only)
formData	Form data, used to build the request body.
headers	The HTTP headers to use when making the request.
keepAlive	If the connection should be reused.
method	The HTTP method to use when making the request.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
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.
operationSpec	Used to parse the response.
proxySettings	Proxy configuration.
query	A query string represented as an object.
requestId	A unique identifier for the request. Used for logging and tracing.
shouldDeserialize	Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
streamResponseBody	Whether or not the body of the HttpOperationResponse should be treated as a stream.
streamResponseStatusCodes	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 AbortError is thrown.
tracingContext	Tracing: Context used when creating spans.
url	The URL being accessed by the request.
withCredentials	If credentials (cookies) should be sent along during an XHR.

Methods

clone()	Clone this request object.
prepare(RequestPrepareOptions)	Sets options on the request.
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.

Property Details

abortSignal

Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

body

The HTTP body contents of the request.

body?: any

Property Value

any

decompressResponse

Whether or not to decompress response according to Accept-Encoding header (node-fetch only)

decompressResponse?: boolean

Property Value

boolean

formData

Form data, used to build the request body.

formData?: any

Property Value

any

headers

The HTTP headers to use when making the request.

headers: HttpHeadersLike

Property Value

HttpHeadersLike

keepAlive

If the connection should be reused.

keepAlive?: boolean

Property Value

boolean

method

The HTTP method to use when making the request.

method: HttpMethods

Property Value

HttpMethods

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property 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 | OperationResponse

Property Value

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Used to parse the response.

operationSpec?: OperationSpec

Property Value

OperationSpec

proxySettings

Proxy configuration.

proxySettings?: ProxySettings

Property Value

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: string

Property 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) => boolean

Property 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?: boolean

Property 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: number

Property Value

number

tracingContext

Tracing: Context used when creating spans.

tracingContext?: Context

Property Value

@azure/core-tracing.Context

url

The URL being accessed by the request.

url: string

Property Value

string

withCredentials

If credentials (cookies) should be sent along during an XHR.

withCredentials: boolean

Property Value

boolean

Method Details

clone()

Clone this request object.

function clone(): WebResourceLike

Returns

WebResourceLike

prepare(RequestPrepareOptions)

Sets options on the request.

function prepare(options: RequestPrepareOptions): WebResourceLike

Parameters

options

RequestPrepareOptions

Returns

WebResourceLike

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()