FileDownloadToBufferOptions interface
Option interface for the downloadToBuffer operation.
- Extends
Properties
abort |
An implementation of the |
concurrency | Concurrency indicates the maximum number of ranges to download in parallel. If not provided, 5 concurrency will be used by default. |
lease |
Lease access conditions. |
max |
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 ShareFileClient.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. |
on |
Progress updater. |
range |
When downloading Azure files, download method will try to split large file into small ranges. Every small range will be downloaded via a separate request. This option defines size data every small request trying to download. Must be greater than 0, will use the default value if undefined, |
Inherited Properties
tracing |
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
concurrency
Concurrency indicates the maximum number of ranges to download in parallel. If not provided, 5 concurrency will be used by default.
concurrency?: number
Property Value
number
leaseAccessConditions
Lease access conditions.
leaseAccessConditions?: LeaseAccessConditions
Property Value
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 ShareFileClient.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
onProgress
Progress updater.
onProgress?: (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 separate request. This option defines size data every small request trying to download. Must be greater than 0, will use the default value if undefined,
rangeSize?: number
Property Value
number