RequestOptionsBase | @azure/core-http

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

[key: string]: any

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

Index

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

customHeaders: undefined | {}

property: {object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

onDownloadProgress: undefined | ((progress: TransferProgressEvent) => void)

Callback which fires upon download progress.

onUploadProgress: undefined | ((progress: TransferProgressEvent) => void)

Callback which fires upon upload progress.

shouldDeserialize: boolean | ((response: HttpOperationResponse) => boolean)

Whether or not the HttpOperationResponse should be deserialized. If this is undefined, then the HttpOperationResponse should be deserialized.

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

timeout: undefined | number

The number of milliseconds a request can take before automatically being terminated. If the request is terminated, an AbortError is thrown.