FileDownloadOptions interface

Package:

@azure/storage-file-share

Options to configure File - Download operations.

See:

• download
• downloadToFile

Extends

CommonOptions

Properties

abortSignal	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.
leaseAccessConditions	Lease access conditions.
maxRetryRequests	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.
onProgress	Download progress updating event handler.
rangeGetContentMD5	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.

Inherited Properties

tracingOptions

Property Details

abortSignal

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.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

leaseAccessConditions

Lease access conditions.

leaseAccessConditions?: LeaseAccessConditions

Property Value

LeaseAccessConditions

maxRetryRequests

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.

maxRetryRequests?: number

Property Value

number

onProgress

Download progress updating event handler.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

rangeGetContentMD5

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.

rangeGetContentMD5?: boolean

Property Value

boolean

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions