你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

FileDownloadToBufferOptions interface

包:

@azure/storage-file-share

downloadToBuffer 操作的选项接口。

Extends

CommonOptions

属性

abortSignal	接口的实现， AbortSignalLike 用于向取消操作的请求发出信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。
concurrency	并发指示要并行下载的最大范围数。 如果未提供，则默认使用 5 个并发。
leaseAccessConditions	租约访问条件。
maxRetryRequestsPerRange	可选。 仅在 NODE.JS 中可用。 原始范围下载流意外结束时将执行的重试次数。 上述类型的结束不会触发管道中定义的重试策略，因为它们不会发出网络错误。 使用此选项时，每次额外的重试意味着将从断点发出额外的 ShareFileClient.download () 请求，直到成功下载请求的范围或达到 maxRetryRequestsPerRange。 默认值为 5，请在网络较差时设置更大的值。
onProgress	进度更新程序。
rangeSize	下载 Azure 文件时，下载方法将尝试将大文件拆分为较小的范围。 每个小范围将通过单独的请求下载。 此选项定义尝试下载的每个小型请求的大小数据。 必须大于 0，如果未定义，将使用默认值，

继承属性

tracingOptions

属性详细信息

abortSignal

接口的实现， AbortSignalLike 用于向取消操作的请求发出信号。 例如，使用 @azure/abort-controller 创建 AbortSignal。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

concurrency

并发指示要并行下载的最大范围数。 如果未提供，则默认使用 5 个并发。

concurrency?: number

属性值

number

leaseAccessConditions

租约访问条件。

leaseAccessConditions?: LeaseAccessConditions

属性值

LeaseAccessConditions

maxRetryRequestsPerRange

可选。 仅在 NODE.JS 中可用。

原始范围下载流意外结束时将执行的重试次数。 上述类型的结束不会触发管道中定义的重试策略，因为它们不会发出网络错误。

使用此选项时，每次额外的重试意味着将从断点发出额外的 ShareFileClient.download () 请求，直到成功下载请求的范围或达到 maxRetryRequestsPerRange。

默认值为 5，请在网络较差时设置更大的值。

maxRetryRequestsPerRange?: number

属性值

number

onProgress

进度更新程序。

onProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

rangeSize

下载 Azure 文件时，下载方法将尝试将大文件拆分为较小的范围。 每个小范围将通过单独的请求下载。 此选项定义尝试下载的每个小型请求的大小数据。 必须大于 0，如果未定义，将使用默认值，

rangeSize?: number

属性值

number

继承属性详细信息

tracingOptions

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自CommonOptions.tracingOptions