FileDownloadOptions interface

Пакет:

@azure/storage-file-share

Параметры для настройки операций скачивания файлов.

Пример

• download
• downloadToFile

Extends

CommonOptions

Свойства

abortSignal	Реализация интерфейса для AbortSignalLike передачи запроса на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.
leaseAccessConditions	Условия доступа к аренде.
maxRetryRequests	Необязательный элемент. ДОСТУПНО ТОЛЬКО В NODE.JS. Сколько повторных попыток будет выполняться при неожиданном завершении потока загрузки исходного текста. Указанные выше типы концов не активируют политику повтора, определенную в конвейере, так как они не вызывают сетевых ошибок. При использовании этого параметра каждая дополнительная повторная попытка означает, что дополнительный запрос ShareFileClient.download() будет выполняться из точки слома, пока запрошенный диапазон не будет успешно скачан или не будет достигнут параметр maxRetryRequests. Значение по умолчанию — 5. Задайте большее значение при загрузке больших файлов в неудовлетворительной сети.
onProgress	Скачивание обработчика событий хода обновления.
rangeGetContentMD5	Если для этого заголовка задано значение true и указано вместе с заголовком Range, служба возвращает хэш MD5 для диапазона при условии, что размер диапазона меньше или равен 4 МБ.

Унаследованные свойства

tracingOptions

Сведения о свойстве

abortSignal

Реализация интерфейса для AbortSignalLike передачи запроса на отмену операции. Например, используйте контроллер @azure/abort-controller для создания AbortSignal.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

leaseAccessConditions

Условия доступа к аренде.

leaseAccessConditions?: LeaseAccessConditions

Значение свойства

LeaseAccessConditions

maxRetryRequests

Необязательный элемент. ДОСТУПНО ТОЛЬКО В NODE.JS.

Сколько повторных попыток будет выполняться при неожиданном завершении потока загрузки исходного текста. Указанные выше типы концов не активируют политику повтора, определенную в конвейере, так как они не вызывают сетевых ошибок.

При использовании этого параметра каждая дополнительная повторная попытка означает, что дополнительный запрос ShareFileClient.download() будет выполняться из точки слома, пока запрошенный диапазон не будет успешно скачан или не будет достигнут параметр maxRetryRequests.

Значение по умолчанию — 5. Задайте большее значение при загрузке больших файлов в неудовлетворительной сети.

maxRetryRequests?: number

Значение свойства

number

onProgress

Скачивание обработчика событий хода обновления.

onProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Если для этого заголовка задано значение true и указано вместе с заголовком Range, служба возвращает хэш MD5 для диапазона при условии, что размер диапазона меньше или равен 4 МБ.

rangeGetContentMD5?: boolean

Значение свойства

boolean

Сведения об унаследованном свойстве

tracingOptions

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

Наследуется отCommonOptions.tracingOptions