FileDownloadOptions interface

Paket:

@azure/storage-file-share

Alternativ för att konfigurera Fil – Nedladdningsåtgärder.

Se:

• Hämta
• downloadToFile

Extends

CommonOptions

Egenskaper

abortSignal	En implementering av AbortSignalLike gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.
leaseAccessConditions	Villkor för låneåtkomst.
maxRetryRequests	Valfritt. ENDAST TILLGÄNGLIGT I NODE.JS. Hur många återförsök kommer att utföras när den ursprungliga nedladdningsströmmen för brödtext oväntat slutar. Ovanstående typer av ändar utlöser inte en återförsöksprincip som definierats i en pipeline, eftersom de inte genererar nätverksfel. Med det här alternativet innebär varje ytterligare återförsök att ytterligare en ShareFileClient.download()-begäran görs från den brutna punkten tills det begärda intervallet har laddats ned eller maxRetryRequests har nåtts. Standardvärdet är 5. Ange ett större värde när du läser in stora filer i dåligt nätverk.
onProgress	Hämta händelsehanteraren för förloppsuppdatering.
rangeGetContentMD5	När det här huvudet anges till true och anges tillsammans med range-huvudet returnerar tjänsten MD5-hashen för intervallet, så länge intervallet är mindre än eller lika med 4 MB i storlek.

Ärvda egenskaper

tracingOptions

Egenskapsinformation

abortSignal

En implementering av AbortSignalLike gränssnittet för att signalera begäran om att avbryta åtgärden. Använd till exempel @azure/abort-controller för att skapa en AbortSignal.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

leaseAccessConditions

Villkor för låneåtkomst.

leaseAccessConditions?: LeaseAccessConditions

Egenskapsvärde

LeaseAccessConditions

maxRetryRequests

Valfritt. ENDAST TILLGÄNGLIGT I NODE.JS.

Hur många återförsök kommer att utföras när den ursprungliga nedladdningsströmmen för brödtext oväntat slutar. Ovanstående typer av ändar utlöser inte en återförsöksprincip som definierats i en pipeline, eftersom de inte genererar nätverksfel.

Med det här alternativet innebär varje ytterligare återförsök att ytterligare en ShareFileClient.download()-begäran görs från den brutna punkten tills det begärda intervallet har laddats ned eller maxRetryRequests har nåtts.

Standardvärdet är 5. Ange ett större värde när du läser in stora filer i dåligt nätverk.

maxRetryRequests?: number

Egenskapsvärde

number

onProgress

Hämta händelsehanteraren för förloppsuppdatering.

onProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

rangeGetContentMD5

När det här huvudet anges till true och anges tillsammans med range-huvudet returnerar tjänsten MD5-hashen för intervallet, så länge intervallet är mindre än eller lika med 4 MB i storlek.

rangeGetContentMD5?: boolean

Egenskapsvärde

boolean

Information om ärvda egenskaper

tracingOptions

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

Ärvd frånCommonOptions.tracingOptions