FileDownloadToBufferOptions interface

Pakiet:

@azure/storage-file-share

Interfejs opcji dla operacji downloadToBuffer.

Rozszerzenie

CommonOptions

Właściwości

abortSignal	Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj @azure/abort-controller, aby utworzyć AbortSignal.
concurrency	Współbieżność wskazuje maksymalną liczbę zakresów do pobrania równolegle. Jeśli nie zostanie podana, domyślnie będzie używana 5 współbieżność.
leaseAccessConditions	Warunki dostępu do dzierżawy.
maxRetryRequestsPerRange	Fakultatywny. DOSTĘPNE TYLKO W NODE.JS. Ile ponownych prób zostanie wykonane po nieoczekiwanym zakończeniu oryginalnego strumienia pobierania zakresu. 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 zostanie wykonane dodatkowe żądanie ShareFileClient.download() z punktu przerwania, dopóki żądany zakres nie zostanie pomyślnie pobrany lub zostanie osiągnięty maksymalny limitRetryRequestsPerRange. Wartość domyślna to 5. Ustaw większą wartość w przypadku słabej sieci.
onProgress	Aktualizator postępu.
rangeSize	Podczas pobierania plików platformy Azure metoda pobierania spróbuje podzielić duży plik na małe zakresy. Każdy mały zakres zostanie pobrany za pośrednictwem oddzielnego żądania. Ta opcja definiuje dane dotyczące rozmiaru każdego małego żądania, które próbuje pobrać. Wartość domyślna musi być większa niż 0, jeśli wartość jest niezdefiniowana,

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ć AbortSignal.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

concurrency

Współbieżność wskazuje maksymalną liczbę zakresów do pobrania równolegle. Jeśli nie zostanie podana, domyślnie będzie używana 5 współbieżność.

concurrency?: number

Wartość właściwości

number

leaseAccessConditions

Warunki dostępu do dzierżawy.

leaseAccessConditions?: LeaseAccessConditions

Wartość właściwości

LeaseAccessConditions

maxRetryRequestsPerRange

Fakultatywny. DOSTĘPNE TYLKO W NODE.JS.

Ile ponownych prób zostanie wykonane po nieoczekiwanym zakończeniu oryginalnego strumienia pobierania zakresu. 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 zostanie wykonane dodatkowe żądanie ShareFileClient.download() z punktu przerwania, dopóki żądany zakres nie zostanie pomyślnie pobrany lub zostanie osiągnięty maksymalny limitRetryRequestsPerRange.

Wartość domyślna to 5. Ustaw większą wartość w przypadku słabej sieci.

maxRetryRequestsPerRange?: number

Wartość właściwości

number

onProgress

Aktualizator postępu.

onProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

rangeSize

Podczas pobierania plików platformy Azure metoda pobierania spróbuje podzielić duży plik na małe zakresy. Każdy mały zakres zostanie pobrany za pośrednictwem oddzielnego żądania. Ta opcja definiuje dane dotyczące rozmiaru każdego małego żądania, które próbuje pobrać. Wartość domyślna musi być większa niż 0, jeśli wartość jest niezdefiniowana,

rangeSize?: number

Wartość właściwości

number

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

tracingOptions

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zCommonOptions.tracingOptions