Delen via

FileDownloadOptions interface

Pakket:
@azure/storage-file-share

Opties voor het configureren van bestand - Downloadbewerkingen.

Zien:

Uitbreiding
CommonOptions

Eigenschappen

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.
leaseAccessConditions

Voorwaarden voor leasetoegang.
maxRetryRequests

Facultatief. ALLEEN BESCHIKBAAR IN NODE.JS.

Hoeveel nieuwe pogingen worden uitgevoerd wanneer de oorspronkelijke stream voor het downloaden van de hoofdtekst onverwacht eindigt. Boven soort einden wordt geen beleid voor opnieuw proberen geactiveerd dat is gedefinieerd in een pijplijn, omdat er geen netwerkfouten worden verzonden.

Met deze optie betekent elke extra nieuwe poging dat er een extra ShareFileClient.download() aanvraag wordt gedaan vanaf het verbroken punt, totdat het aangevraagde bereik is gedownload of maxRetryRequests is bereikt.

De standaardwaarde is 5. Stel een hogere waarde in bij het laden van grote bestanden in een slecht netwerk.
onProgress

Download voortgang bij het bijwerken van gebeurtenis-handler.
rangeGetContentMD5

Wanneer deze header is ingesteld op true en samen met de bereikheader is opgegeven, retourneert de service de MD5-hash voor het bereik, zolang het bereik kleiner is dan of gelijk is aan 4 MB.

Overgenomen eigenschappen

tracingOptions

Eigenschapdetails

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

leaseAccessConditions

Voorwaarden voor leasetoegang.

leaseAccessConditions?: LeaseAccessConditions

Waarde van eigenschap

LeaseAccessConditions

maxRetryRequests

Facultatief. ALLEEN BESCHIKBAAR IN NODE.JS.

Hoeveel nieuwe pogingen worden uitgevoerd wanneer de oorspronkelijke stream voor het downloaden van de hoofdtekst onverwacht eindigt. Boven soort einden wordt geen beleid voor opnieuw proberen geactiveerd dat is gedefinieerd in een pijplijn, omdat er geen netwerkfouten worden verzonden.

Met deze optie betekent elke extra nieuwe poging dat er een extra ShareFileClient.download() aanvraag wordt gedaan vanaf het verbroken punt, totdat het aangevraagde bereik is gedownload of maxRetryRequests is bereikt.

De standaardwaarde is 5. Stel een hogere waarde in bij het laden van grote bestanden in een slecht netwerk.

maxRetryRequests?: number

Waarde van eigenschap

number

onProgress

Download voortgang bij het bijwerken van gebeurtenis-handler.

onProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Wanneer deze header is ingesteld op true en samen met de bereikheader is opgegeven, retourneert de service de MD5-hash voor het bereik, zolang het bereik kleiner is dan of gelijk is aan 4 MB.

rangeGetContentMD5?: boolean

Waarde van eigenschap

boolean

Details van overgenomen eigenschap

tracingOptions 

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen vanCommonOptions.tracingOptions-