Package version:

Interface FileDownloadOptions

Options to configure File - Download operations.

See:

interface FileDownloadOptions {
    abortSignal?: any;
    leaseAccessConditions?: LeaseAccessConditions;
    maxRetryRequests?: number;
    onProgress?: ((progress: TransferProgressEvent) => void);
    rangeGetContentMD5?: boolean;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? leaseAccessConditions? maxRetryRequests? onProgress? rangeGetContentMD5? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

OptionalleaseAccessConditions

leaseAccessConditions?: LeaseAccessConditions

Lease access conditions.

OptionalmaxRetryRequests

maxRetryRequests?: number

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 ShareFileClient.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.

OptionalonProgress

onProgress?: ((progress: TransferProgressEvent) => void)

Download progress updating event handler.

OptionalrangeGetContentMD5

rangeGetContentMD5?: boolean

When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.

OptionaltracingOptions

tracingOptions?: any

Settings

Member Visibility