FileDownloadToBufferOptions interface

downloadToBuffer 作業的選項介面。

屬性

abortSignal	`AbortSignalLike` 介面的實作，以發出取消作業的要求。例如，使用 @azure/abort-controller 來建立 `AbortSignal`。
concurrency	並行表示平行下載的範圍數目上限。如果未提供，預設會使用5個並行存取。
leaseAccessConditions	租用存取條件。
maxRetryRequestsPerRange	自選。僅適用於 NODE.JS。原始範圍下載數據流非預期結束時，將會執行多少次重試。上述類型的結束不會觸發管線中定義的重試原則，因為它們不會發出網路錯誤。使用此選項時，每個額外的重試表示會從中斷點提出額外的ShareFileClient.download（）要求，直到成功下載要求的範圍或達到 MaxRetryRequestsPerRange為止。默認值為 5，當網路不佳時，請設定較大的值。
onProgress	進度更新程式。
rangeSize	下載 Azure 檔案時，下載方法會嘗試將大型檔案分割成小型範圍。每個小型範圍都會透過個別的要求下載。這個選項會定義嘗試下載的每個小型要求的大小數據。必須大於 0，如果未定義，則會使用預設值。

AbortSignalLike 介面的實作，以發出取消作業的要求。例如，使用 @azure/abort-controller 來建立 AbortSignal。

abortSignal?: AbortSignalLike

並行表示平行下載的範圍數目上限。如果未提供，預設會使用5個並行存取。

concurrency?: number

number

租用存取條件。

leaseAccessConditions?: LeaseAccessConditions

自選。僅適用於 NODE.JS。

原始範圍下載數據流非預期結束時，將會執行多少次重試。上述類型的結束不會觸發管線中定義的重試原則，因為它們不會發出網路錯誤。

使用此選項時，每個額外的重試表示會從中斷點提出額外的ShareFileClient.download（）要求，直到成功下載要求的範圍或達到 MaxRetryRequestsPerRange為止。

默認值為 5，當網路不佳時，請設定較大的值。

maxRetryRequestsPerRange?: number

number

進度更新程式。

onProgress?: (progress: TransferProgressEvent) => void

(progress: TransferProgressEvent) => void

下載 Azure 檔案時，下載方法會嘗試將大型檔案分割成小型範圍。每個小型範圍都會透過個別的要求下載。這個選項會定義嘗試下載的每個小型要求的大小數據。必須大於 0，如果未定義，則會使用預設值。

rangeSize?: number

number

tracingOptions?: OperationTracingOptions