Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestOptionsBase

Package version

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

Hierarchy

Indexable

[key: string]: any

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

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional customHeaders

customHeaders: undefined | object
property

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

Optional onDownloadProgress

onDownloadProgress: undefined | function

Callback which fires upon download progress.

Optional onUploadProgress

onUploadProgress: undefined | function

Callback which fires upon upload progress.

Optional spanOptions

spanOptions: SpanOptions

Options used to create a span when tracing is enabled.

Optional timeout

timeout: undefined | number

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

Generated using TypeDoc