Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileDownloadToBufferOptions

Package version

Option interface for the ShareFileClient.downloadToBuffer operation.

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.

Optional concurrency

concurrency: undefined | number

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

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Lease access conditions.

Optional maxRetryRequestsPerRange

maxRetryRequestsPerRange: undefined | number

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.

Optional onProgress

onProgress: undefined | ((progress: TransferProgressEvent) => void)

Progress updater.

Optional rangeSize

rangeSize: undefined | number

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,

Optional tracingOptions

tracingOptions: OperationTracingOptions

Generated using TypeDoc