Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileDownloadOptions

Package version

Options to configure File - Download operation.

export
interface

FileDownloadOptions

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

type

{AbortSignalLike}

memberof

AppendBlobCreateOptions

Optional maxRetryRequests

maxRetryRequests: undefined | number

Optional. ONLY AVAILABLE IN NODE.JS.

How many retries will perform when original body download stream unexpected ends. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors.

With this option, every additional retry means an additional ShareFileClient.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached.

Default value is 5, please set a larger value when loading large files in poor network.

type

{number}

memberof

FileDownloadOptions

Optional onProgress

onProgress: undefined | function

Download progress updating event handler.

memberof

FileDownloadOptions

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.

type

{boolean}

memberof

FileDownloadOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Generated using TypeDoc