Interface DownloadOptions

🏷️ Properties

abortSignal optional

abortSignal: AbortSignal

The user abort signal to abort the download

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

checkpointHandler optional

checkpointHandler: CheckpointHandler

The checkpoint handler to save & restore the download progress Inherited from: DownloadBaseOptions.checkpointHandler

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

destination

destination: string

Where the file will be downloaded to

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

dispatcher optional

dispatcher: Dispatcher

The undici dispatcher Inherited from: DownloadBaseOptions.dispatcher

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

headers optional

headers: Record<string, any>

The header of the request

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

pendingFile optional

pendingFile: string

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

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

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:77

rangePolicy optional

rangePolicy: RangePolicy

The range policy to compute the ranges to download Inherited from: DownloadBaseOptions.rangePolicy

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

skipHead optional

skipHead: boolean

Inherited from: DownloadBaseOptions.skipHead

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

skipPrevalidate optional

skipPrevalidate: boolean

Inherited from: DownloadBaseOptions.skipPrevalidate

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

skipRevalidate optional

skipRevalidate: boolean

Inherited from: DownloadBaseOptions.skipRevalidate

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

url

url: string | string[]

The url or urls (fallback) of the resource

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

validator optional

validator: Validator | ChecksumValidatorOptions

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

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