FileDownloadToBufferOptions interface

包:

@azure/storage-file-share

<xref:ShareFileClient.downloadToBuffer>作的选项接口。

扩展

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