FileDownloadOptions interface

Pakket:

@azure/storage-file-share

Opties voor het configureren van Bestand - Downloadbewerkingen.

Zie:

• Downloaden
• downloadToFile

Extends

CommonOptions

Eigenschappen

abortSignal	Een implementatie van de AbortSignalLike interface om de aanvraag om de bewerking te annuleren aan te geven. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.
leaseAccessConditions	Voorwaarden voor leasetoegang.
maxRetryRequests	Optioneel. ALLEEN BESCHIKBAAR IN NODE.JS. Hoeveel nieuwe pogingen worden uitgevoerd wanneer de oorspronkelijke downloadstroom voor hoofdtekst onverwacht eindigt. Het bovenstaande soort eindpunten activeert geen beleid voor opnieuw proberen dat is gedefinieerd in een pijplijn, omdat er geen netwerkfouten optreden. Met deze optie betekent elke nieuwe poging dat er een extra ShareFileClient.download()-aanvraag wordt gedaan vanaf het gebroken punt, totdat het aangevraagde bereik is gedownload of maxRetryRequests is bereikt. De standaardwaarde is 5. Stel een grotere waarde in bij het laden van grote bestanden in een slecht netwerk.
onProgress	Download de voortgang van het bijwerken van de 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, mits 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 om de bewerking te annuleren aan te geven. 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

Optioneel. ALLEEN BESCHIKBAAR IN NODE.JS.

Hoeveel nieuwe pogingen worden uitgevoerd wanneer de oorspronkelijke downloadstroom voor hoofdtekst onverwacht eindigt. Het bovenstaande soort eindpunten activeert geen beleid voor opnieuw proberen dat is gedefinieerd in een pijplijn, omdat er geen netwerkfouten optreden.

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

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

maxRetryRequests?: number

Waarde van eigenschap

number

onProgress

Download de voortgang van het bijwerken van de 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, mits 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