FileDownloadOptions interface

Paket:

@azure/storage-file-share

Optionen zum Konfigurieren von Datei - Downloadvorgängen.

Siehe:

• Herunterladen
• downloadToFile

Extends

CommonOptions

Eigenschaften

abortSignal	Eine Implementierung der Schnittstelle, um AbortSignalLike die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/abort-controller, um einen AbortSignalzu erstellen.
leaseAccessConditions	Lease-Zugriffsbedingungen.
maxRetryRequests	Dies ist optional. NUR IN NODE.JS VERFÜGBAR. Wie viele Wiederholungen ausgeführt werden, wenn der ursprüngliche Textdownloadstream unerwartet endet. Die oben genannten Enden lösen keine Wiederholungsrichtlinie aus, die in einer Pipeline definiert ist, da sie keine Netzwerkfehler ausgibt. Bei dieser Option bedeutet jeder zusätzliche Wiederholungsversuch, dass eine zusätzliche ShareFileClient.download()-Anforderung vom Unterbrochenen Punkt gesendet wird, bis der angeforderte Bereich erfolgreich heruntergeladen oder maxRetryRequests erreicht wurde. Der Standardwert ist 5. Legen Sie beim Laden großer Dateien in einem schlechten Netzwerk einen größeren Wert fest.
onProgress	Laden Sie den Statusaktualisierungs-Ereignishandler herunter.
rangeGetContentMD5	Wenn dieser Header auf true festgelegt und zusammen mit dem Range-Header angegeben wird, gibt der Dienst den MD5-Hash für den Bereich zurück, solange der Bereich kleiner als oder gleich 4 MB ist.

Geerbte Eigenschaften

tracingOptions

Details zur Eigenschaft

abortSignal

Eine Implementierung der Schnittstelle, um AbortSignalLike die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/abort-controller, um einen AbortSignalzu erstellen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

leaseAccessConditions

Lease-Zugriffsbedingungen.

leaseAccessConditions?: LeaseAccessConditions

Eigenschaftswert

LeaseAccessConditions

maxRetryRequests

Dies ist optional. NUR IN NODE.JS VERFÜGBAR.

Wie viele Wiederholungen ausgeführt werden, wenn der ursprüngliche Textdownloadstream unerwartet endet. Die oben genannten Enden lösen keine Wiederholungsrichtlinie aus, die in einer Pipeline definiert ist, da sie keine Netzwerkfehler ausgibt.

Bei dieser Option bedeutet jeder zusätzliche Wiederholungsversuch, dass eine zusätzliche ShareFileClient.download()-Anforderung vom Unterbrochenen Punkt gesendet wird, bis der angeforderte Bereich erfolgreich heruntergeladen oder maxRetryRequests erreicht wurde.

Der Standardwert ist 5. Legen Sie beim Laden großer Dateien in einem schlechten Netzwerk einen größeren Wert fest.

maxRetryRequests?: number

Eigenschaftswert

number

onProgress

Laden Sie den Statusaktualisierungs-Ereignishandler herunter.

onProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Wenn dieser Header auf true festgelegt und zusammen mit dem Range-Header angegeben wird, gibt der Dienst den MD5-Hash für den Bereich zurück, solange der Bereich kleiner als oder gleich 4 MB ist.

rangeGetContentMD5?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

tracingOptions

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt vonCommonOptions.tracingOptions