FileDownloadOptions interface
- Extends
屬性
abort |
|
lease |
租用存取條件。 |
max |
自選。 僅適用於 NODE.JS。 原始本文下載數據流未預期結束時,將會執行多少次重試。 上述類型的結束不會觸發管線中定義的重試原則,因為它們不會發出網路錯誤。 使用此選項時,每個額外的重試表示會從中斷點提出額外的ShareFileClient.download() 要求,直到成功下載要求的範圍或達到 MaxRetryRequests為止。 默認值為 5,請在不良網路中載入大型檔案時設定較大的值。 |
on |
下載進度更新事件處理程式。 |
range |
當此標頭設定為 true 且與 Range 標頭一起指定時,服務會傳回該範圍的 MD5 哈希,只要範圍的大小小於或等於 4 MB。 |
繼承的屬性
tracing |
屬性詳細資料
abortSignal
AbortSignalLike
介面的實作,以發出取消作業的要求。
例如,使用 @azure/abort-controller 來建立 AbortSignal
。
abortSignal?: AbortSignalLike
屬性值
leaseAccessConditions
maxRetryRequests
自選。 僅適用於 NODE.JS。
原始本文下載數據流未預期結束時,將會執行多少次重試。 上述類型的結束不會觸發管線中定義的重試原則,因為它們不會發出網路錯誤。
使用此選項時,每個額外的重試表示會從中斷點提出額外的ShareFileClient.download() 要求,直到成功下載要求的範圍或達到 MaxRetryRequests為止。
默認值為 5,請在不良網路中載入大型檔案時設定較大的值。
maxRetryRequests?: number
屬性值
number
onProgress
下載進度更新事件處理程式。
onProgress?: (progress: TransferProgressEvent) => void
屬性值
(progress: TransferProgressEvent) => void
rangeGetContentMD5
當此標頭設定為 true 且與 Range 標頭一起指定時,服務會傳回該範圍的 MD5 哈希,只要範圍的大小小於或等於 4 MB。
rangeGetContentMD5?: boolean
屬性值
boolean
繼承的屬性詳細資料
tracingOptions
tracingOptions?: OperationTracingOptions