FileDownloadToBufferOptions interface

Pakiet:

@azure/storage-file-share

Interfejs opcji dla downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions) operacji.

Extends

CommonOptions

Właściwości

abortSignal	Implementacja interfejsu AbortSignalLike sygnalizuje żądanie anulowania operacji. Na przykład użyj kontrolera @azure/abort-controller, aby utworzyć element 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 dzierżawy.
maxRetryRequestsPerRange	Opcjonalny. DOSTĘPNE TYLKO W NODE.JS. Ile ponownych prób zostanie wykonane, gdy oryginalny strumień pobierania zakresu niespodziewanie kończy się. Powyższe końce nie będą wyzwalać zasad ponawiania prób zdefiniowanych w potoku, ponieważ nie emitują błędów sieci. Dzięki tej opcji każda dodatkowa ponowna próba oznacza, że zostanie wykonane dodatkowe żądanie ShareFileClient.download() z uszkodzonego punktu, dopóki żądany zakres nie zostanie pomyślnie pobrany lub zostanie osiągnięty maxRetryRequestsPerRange. Wartość domyślna to 5, należy ustawić 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 rozmiaru każdego małego żądania, które próbuje pobrać. Wartość domyślna musi być większa niż 0, jeśli niezdefiniowana, będzie używana wartość domyślna.

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 kontrolera @azure/abort-controller, aby utworzyć element 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 dzierżawy.

leaseAccessConditions?: LeaseAccessConditions

Wartość właściwości

LeaseAccessConditions

maxRetryRequestsPerRange

Opcjonalny. DOSTĘPNE TYLKO W NODE.JS. Ile ponownych prób zostanie wykonane, gdy oryginalny strumień pobierania zakresu niespodziewanie kończy się. Powyższe końce nie będą wyzwalać zasad ponawiania prób zdefiniowanych w potoku, ponieważ nie emitują błędów sieci.

Dzięki tej opcji każda dodatkowa ponowna próba oznacza, że zostanie wykonane dodatkowe żądanie ShareFileClient.download() z uszkodzonego punktu, dopóki żądany zakres nie zostanie pomyślnie pobrany lub zostanie osiągnięty maxRetryRequestsPerRange.

Wartość domyślna to 5, należy ustawić 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 rozmiaru każdego małego żądania, które próbuje pobrać. Wartość domyślna musi być większa niż 0, jeśli niezdefiniowana, będzie używana wartość domyślna.

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