Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileDownloadOptionalParams

Package version

Optional Parameters.

Hierarchy

Indexable

[key: string]: any

Optional Parameters.

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 range

range: undefined | string

Return file data only from the specified byte range.

Optional rangeGetContentMD5

rangeGetContentMD5: undefined | false | true

When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.

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.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Generated using TypeDoc