OperationRequestOptions interface

Package:

@azure/core-http

Options that allow configuring the handling of HTTP requests made by an SDK operation.

Properties

customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
shouldDeserialize	Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

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

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

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number