FileDownloadOptions interface

Пакет:

@azure/storage-file-share

Параметры настройки файлов — операции загрузки.

Видеть:

• скачивание
• 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