Interface DownloadOptions

🏷️ Properties

abortSignal optional

abortSignal: AbortSignal

The user abort signal to abort the download

Defined in: packages/file-transfer/download.ts:57

agent optional

agent: DownloadAgent

The download agent Inherited from: DownloadBaseOptions.agent

Defined in: packages/file-transfer/download.ts:20

destination

destination: string

Where the file will be downloaded to

Defined in: packages/file-transfer/download.ts:45

headers optional

headers: Record<string, any>

The header of the request

Defined in: packages/file-transfer/download.ts:41

pendingFile optional

pendingFile: string

Will first download to pending file and then rename to actual file

Defined in: packages/file-transfer/download.ts:61

progressController optional

progressController: ProgressController

The progress controller. If you want to track download progress, you should use this.

Defined in: packages/file-transfer/download.ts:49

skipPrevalidate optional

skipPrevalidate: boolean

Should skip prevalidate the file Inherited from: DownloadBaseOptions.skipPrevalidate

Defined in: packages/file-transfer/download.ts:30

skipRevalidate optional

skipRevalidate: boolean

Re-validate the file after download success Inherited from: DownloadBaseOptions.skipRevalidate

Defined in: packages/file-transfer/download.ts:25

url

url: string | string[]

The url or urls (fallback) of the resource

Defined in: packages/file-transfer/download.ts:37

validator optional

validator: Validator | ChecksumValidatorOptions

The validator, or the options to create a validator based on checksum.

Defined in: packages/file-transfer/download.ts:53