RequestOptionsBase interface
Describes the base structure of the options object that will be used in every operation.
Properties
| abort |
Signal of an abort controller. Can be used to abort both sending a network request and waiting for a response. |
| custom |
will be applied before the request is sent. |
| on |
Callback which fires upon download progress. |
| on |
Callback which fires upon upload progress. |
| serializer |
Options to override XML parsing/building behavior. |
| should |
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 |
| tracing |
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?: AbortSignalLikeProperty Value
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) => voidProperty Value
(progress: TransferProgressEvent) => void
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
serializerOptions
Options to override XML parsing/building behavior.
serializerOptions?: SerializerOptionsProperty Value
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
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?: Context