RequestOptionsBase interface

Package:

@azure/core-http

Describes the base structure of the options object that will be used in every operation.

Properties

abortSignal	Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response.
customHeaders	will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
serializerOptions	Options to override XML parsing/building behavior.
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. If the request is terminated, an AbortError is thrown.
tracingContext	Tracing: Context used when creating spans.

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

customHeaders

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

serializerOptions

Options to override XML parsing/building behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

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. 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