Options to configure the download operation.
Properties abortSignalAn implementation of the AbortSignalLike
interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal
.
Conditions to meet when downloading blobs.
customerProvidedKeyCustomer Provided Key Info.
maxRetryRequestsOptional. ONLY AVAILABLE IN NODE.JS.
How many retries will perform when original body 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 range has been successfully downloaded or maxRetryRequests is reached.
Default value is 5, please set a larger value when loading large files in poor network.
onProgressCall back to receive events on the progress of download operation.
rangeGetContentCrc64When this is set to true and download range of blob, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
rangeGetContentMD5When this is set to true and download range of blob, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
snapshotAn opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.
Inherited Properties tracingOptionsOptions to configure spans created when tracing is enabled.
Property Details abortSignalAn implementation of the AbortSignalLike
interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal
.
abortSignal?: AbortSignalLike
Property Value conditions
Conditions to meet when downloading blobs.
conditions?: BlobRequestConditions
Property Value customerProvidedKey
Customer Provided Key Info.
customerProvidedKey?: CpkInfo
Property Value maxRetryRequests
Optional. ONLY AVAILABLE IN NODE.JS.
How many retries will perform when original body 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 range has been successfully downloaded or maxRetryRequests is reached.
Default value is 5, please set a larger value when loading large files in poor network.
maxRetryRequests?: number
Property Value
number
onProgressCall back to receive events on the progress of download operation.
onProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
rangeGetContentCrc64When this is set to true and download range of blob, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
rangeGetContentCrc64?: boolean
Property Value
boolean
rangeGetContentMD5When this is set to true and download range of blob, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
rangeGetContentMD5?: boolean
Property Value
boolean
snapshotAn opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.
snapshot?: string
Property Value
string
Inherited Property Details tracingOptionsOptions to configure spans created when tracing is enabled.
tracingOptions?: OperationTracingOptions
Property Value
Inherited From CommonOptions.tracingOptions
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4