Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BlobDownloadToBufferOptions

Package version

Option interface for the BlobClient.downloadToBuffer operation.

export
interface

BlobDownloadToBufferOptions

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

BlobDownloadToBufferOptions

Optional blockSize

blockSize: undefined | number

blockSize is the data every request trying to download. Must be >= 0, if set to 0 or undefined, blockSize will automatically calculated according to the blob size.

type

{number}

memberof

BlobDownloadToBufferOptions

Optional concurrency

concurrency: undefined | number

Concurrency of parallel download.

type

{number}

memberof

BlobDownloadToBufferOptions

Optional conditions

Access conditions headers.

type

{BlobRequestConditions}

memberof

BlobDownloadToBufferOptions

Optional maxRetryRequestsPerBlock

maxRetryRequestsPerBlock: undefined | number

Optional. ONLY AVAILABLE IN NODE.JS.

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

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

type

{number}

memberof

BlobDownloadToBufferOptions

Optional onProgress

onProgress: undefined | function

Progress updater.

type

{(progress: TransferProgressEvent) => void}

memberof

BlobDownloadToBufferOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc