FileDownloadOptions interface

Pakiet:

@azure/storage-file-share

Opcje konfigurowania pliku — operacje pobierania. Zobacz:

• download(number, number, FileDownloadOptions)
• downloadToFile(string, number, number, FileDownloadOptions)

Extends

CommonOptions

Właściwości

abortSignal	Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć element AbortSignal.
leaseAccessConditions	Warunki dostępu do dzierżawy.
maxRetryRequests	Opcjonalny. DOSTĘPNE TYLKO W NODE.JS. Ile ponownych prób zostanie wykonane po nieoczekiwanym zakończeniu oryginalnego strumienia pobierania treści. Powyższe typy końców nie będą wyzwalać zasad ponawiania prób zdefiniowanych w potoku, ponieważ nie emitują błędów sieci. W przypadku tej opcji każda dodatkowa ponowna próba oznacza, że dodatkowe żądanie ShareFileClient.download() zostanie wykonane z punktu przerwania do momentu pomyślnego pobrania żądanego zakresu lub osiągnięcia parametru maxRetryRequests. Wartość domyślna to 5. Podczas ładowania dużych plików w złej sieci ustaw większą wartość.
onProgress	Pobieranie postępu aktualizowania programu obsługi zdarzeń.
rangeGetContentMD5	Gdy ten nagłówek jest ustawiony na wartość true i określony razem z nagłówkiem Zakres, usługa zwraca skrót MD5 dla zakresu, o ile zakres jest mniejszy lub równy 4 MB rozmiaru.

Właściwości dziedziczone

tracingOptions

Szczegóły właściwości

abortSignal

Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć element AbortSignal.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

leaseAccessConditions

Warunki dostępu do dzierżawy.

leaseAccessConditions?: LeaseAccessConditions

Wartość właściwości

LeaseAccessConditions

maxRetryRequests

Opcjonalny. DOSTĘPNE TYLKO W NODE.JS. Ile ponownych prób zostanie wykonane po nieoczekiwanym zakończeniu oryginalnego strumienia pobierania treści. Powyższe typy końców nie będą wyzwalać zasad ponawiania prób zdefiniowanych w potoku, ponieważ nie emitują błędów sieci.

W przypadku tej opcji każda dodatkowa ponowna próba oznacza, że dodatkowe żądanie ShareFileClient.download() zostanie wykonane z punktu przerwania do momentu pomyślnego pobrania żądanego zakresu lub osiągnięcia parametru maxRetryRequests.

Wartość domyślna to 5. Podczas ładowania dużych plików w złej sieci ustaw większą wartość.

maxRetryRequests?: number

Wartość właściwości

number

onProgress

Pobieranie postępu aktualizowania programu obsługi zdarzeń.

onProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Gdy ten nagłówek jest ustawiony na wartość true i określony razem z nagłówkiem Zakres, usługa zwraca skrót MD5 dla zakresu, o ile zakres jest mniejszy lub równy 4 MB rozmiaru.

rangeGetContentMD5?: boolean

Wartość właściwości

boolean

Szczegóły właściwości dziedziczonej

tracingOptions

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone zcommonOptions.tracingOptions