RequestOptionsBase interface

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

Properties

abortSignal

The signal which can be used to abort requests.

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.

timeout

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

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

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

timeout

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

timeout?: number

Property Value

number