Class DownloadTask

The controller that maintain the download status

🏭 Constructors

constructor

new DownloadTask(options: DownloadOptions): DownloadTask

Parameters

• options: DownloadOptions

Return Type

• DownloadTask

Defined in: packages/installer/downloadTask.ts:7

🏷️ Properties

_from protected

_from: undefined | string

Inherited from: AbortableTask._from

Defined in: packages/task/index.ts:80

_id protected

_id: number = 0

Inherited from: AbortableTask._id

Defined in: packages/task/index.ts:85

_path protected

_path: string = ''

Inherited from: AbortableTask._path

Defined in: packages/task/index.ts:84

_pausing protected

_pausing: Promise<void> = ...

Inherited from: AbortableTask._pausing

Defined in: packages/task/index.ts:224

_progress protected

_progress: number = 0

Inherited from: AbortableTask._progress

Defined in: packages/task/index.ts:82

_promise protected

_promise: Promise<void>

Inherited from: AbortableTask._promise

Defined in: packages/task/index.ts:75

_state protected

_state: TaskState = TaskState.Idle

Inherited from: AbortableTask._state

Defined in: packages/task/index.ts:74

_to protected

_to: undefined | string

Inherited from: AbortableTask._to

Defined in: packages/task/index.ts:81

_total protected

_total: number = -1

Inherited from: AbortableTask._total

Defined in: packages/task/index.ts:83

abort protected

abort: Function = ...

Defined in: packages/installer/downloadTask.ts:5

context

context: TaskContext = {}

Inherited from: AbortableTask.context

Defined in: packages/task/index.ts:88

name

name: string = ''

Inherited from: AbortableTask.name

Defined in: packages/task/index.ts:90

options protected

options: DownloadOptions

Defined in: packages/installer/downloadTask.ts:7

param

param: object = {}

Inherited from: AbortableTask.param

Defined in: packages/task/index.ts:91

parent

parent: undefined | Task<any>

Inherited from: AbortableTask.parent

Defined in: packages/task/index.ts:87

reject protected

reject: Function

Inherited from: AbortableTask.reject

Defined in: packages/task/index.ts:78

resolve protected

resolve: Function

Inherited from: AbortableTask.resolve

Defined in: packages/task/index.ts:77

resultOrError protected

resultOrError: any

Inherited from: AbortableTask.resultOrError

Defined in: packages/task/index.ts:93

🔑 Accessors

from

Inherited from: AbortableTask.from

Defined in: packages/task/index.ts:121

id

Inherited from: AbortableTask.id

Defined in: packages/task/index.ts:116

isCancelled

Inherited from: AbortableTask.isCancelled

Defined in: packages/task/index.ts:124

isDone

Inherited from: AbortableTask.isDone

Defined in: packages/task/index.ts:126

isPaused

Inherited from: AbortableTask.isPaused

Defined in: packages/task/index.ts:125

isRunning

Inherited from: AbortableTask.isRunning

Defined in: packages/task/index.ts:127

path

Inherited from: AbortableTask.path

Defined in: packages/task/index.ts:117

progress

Inherited from: AbortableTask.progress

Defined in: packages/task/index.ts:118

state

Inherited from: AbortableTask.state

Defined in: packages/task/index.ts:122

to

Inherited from: AbortableTask.to

Defined in: packages/task/index.ts:120

total

Inherited from: AbortableTask.total

Defined in: packages/task/index.ts:119

🔧 Methods

_onAborted protected

_onAborted(): void

Return Type

• void

Inherited from: AbortableTask._onAborted

Defined in: packages/task/index.ts:226

_onResume protected

_onResume(): void

Return Type

• void

Inherited from: AbortableTask._onResume

Defined in: packages/task/index.ts:227

_unpause protected

_unpause(): void

Return Type

• void

Inherited from: AbortableTask._unpause

Defined in: packages/task/index.ts:225

cancel

cancel(timeout: number): Promise<void>

Parameters

• timeout: number

Return Type

• Promise<void>

Inherited from: AbortableTask.cancel

Defined in: packages/task/index.ts:145

cancelTask protected

cancelTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.cancelTask

Defined in: packages/task/index.ts:233

get

get(): void

Return Type

• void

Inherited from: AbortableTask.get

Defined in: packages/task/index.ts:108

isAbortedError protected

isAbortedError(e: any): boolean

Parameters

• e: any

Return Type

• boolean

Defined in: packages/installer/downloadTask.ts:47

map

map(transform: Transform<DownloadTask, N>): Task<N extends Promise<R> ? R : N>

Parameters

• transform: Transform<DownloadTask, N>

Return Type

• Task<N extends Promise<R> ? R : N>

Inherited from: AbortableTask.map

Defined in: packages/task/index.ts:212

onChildUpdate

onChildUpdate(chunkSize: number): void

Parameters

• chunkSize: number

Return Type

• void

Inherited from: AbortableTask.onChildUpdate

Defined in: packages/task/index.ts:205

onProgress

onProgress(url: URL, chunkSize: number, progress: number, total: number): void

Parameters

• url: URL
• chunkSize: number
• progress: number
• total: number

Return Type

• void

Defined in: packages/installer/downloadTask.ts:13

pause

pause(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.pause

Defined in: packages/task/index.ts:129

pauseTask protected

pauseTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.pauseTask

Defined in: packages/task/index.ts:240

process protected

process(): Promise<void>

Return Type

• Promise<void>

Defined in: packages/installer/downloadTask.ts:20

resume

resume(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.resume

Defined in: packages/task/index.ts:137

resumeTask protected

resumeTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.resumeTask

Defined in: packages/task/index.ts:250

runTask protected

runTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.runTask

Defined in: packages/task/index.ts:257

setName

setName(name: string, param: object): DownloadTask

Parameters

• name: string
• param: object

Return Type

• DownloadTask

Inherited from: AbortableTask.setName

Defined in: packages/task/index.ts:102

start

start(context: TaskContext, parent: Task<any>): void

Parameters

• context: TaskContext
• parent: Task<any>

Return Type

• void

Inherited from: AbortableTask.start

Defined in: packages/task/index.ts:164

startAndWait

startAndWait(context: TaskContext, parent: Task<any>): Promise<void>

Parameters

• context: TaskContext
• parent: Task<any>

Return Type

• Promise<void>

Inherited from: AbortableTask.startAndWait

Defined in: packages/task/index.ts:195

update protected

update(chunkSize: number): void

Parameters

• chunkSize: number

Return Type

• void

Inherited from: AbortableTask.update

Defined in: packages/task/index.ts:200

wait

wait(): Promise<void>

Return Type

• Promise<void>

Inherited from: AbortableTask.wait

Defined in: packages/task/index.ts:160