IDownloadFromAzureFileOptions interface

Package:

@azure/storage-file

Option interface for DownloadAzurefileToBuffer.

Properties

maxRetryRequestsPerRange	Optional. ONLY AVAILABLE IN NODE.JS. How many retries will perform when original range 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 FileURL.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequestsPerRange is reached. Default value is 5, please set a larger value when in poor network.
parallelism	Parallelism indicates the maximum number of ranges to download in parallel. If not provided, 5 parallelism will be used by default.
progress	Progress updater.
rangeSize	When downloading Azure files, download method will try to split large file into small ranges. Every small range will be downloaded via a separte request. This option defines size data every small request trying to download. Must be > 0, will use the default value if undefined,

Property Details

maxRetryRequestsPerRange

Optional. ONLY AVAILABLE IN NODE.JS.

How many retries will perform when original range 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 FileURL.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequestsPerRange is reached.

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

maxRetryRequestsPerRange?: number

Property Value

number

parallelism

Parallelism indicates the maximum number of ranges to download in parallel. If not provided, 5 parallelism will be used by default.

parallelism?: number

Property Value

number

progress

Progress updater.

progress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

rangeSize

When downloading Azure files, download method will try to split large file into small ranges. Every small range will be downloaded via a separte request. This option defines size data every small request trying to download. Must be > 0, will use the default value if undefined,

rangeSize?: number

Property Value

number