Class DownloadForgeInstallerTask
The controller that maintain the download status
🏭 Constructors
constructor
new DownloadForgeInstallerTask(forgeVersion: string, installer: undefined | Object, minecraft: MinecraftFolder, options: InstallForgeOptions, legacy: boolean): DownloadForgeInstallerTask
Parameters
- forgeVersion:
string
- installer:
undefined | Object
- minecraft:
MinecraftFolder
- options:
InstallForgeOptions
- legacy:
boolean
Return Type
DownloadForgeInstallerTask
Defined in: packages/installer/forge.ts:149
🏷️ Properties
_from protected
_from: undefined | string
Inherited from: DownloadTask._from
Defined in: packages/task/index.ts:80
_id protected
_id: number = 0
Inherited from: DownloadTask._id
Defined in: packages/task/index.ts:85
_path protected
_path: string = ''
Inherited from: DownloadTask._path
Defined in: packages/task/index.ts:84
_pausing protected
_pausing: Promise<void> = ...
Inherited from: DownloadTask._pausing
Defined in: packages/task/index.ts:224
_progress protected
_progress: number = 0
Inherited from: DownloadTask._progress
Defined in: packages/task/index.ts:82
_promise protected
_promise: Promise<void>
Inherited from: DownloadTask._promise
Defined in: packages/task/index.ts:75
_state protected
_state: TaskState = TaskState.Idle
Inherited from: DownloadTask._state
Defined in: packages/task/index.ts:74
_to protected
_to: undefined | string
Inherited from: DownloadTask._to
Defined in: packages/task/index.ts:81
_total protected
_total: number = -1
Inherited from: DownloadTask._total
Defined in: packages/task/index.ts:83
abort protected
abort: Function = ...
Inherited from: DownloadTask.abort
Defined in: packages/installer/downloadTask.ts:5
context
context: TaskContext = {}
Inherited from: DownloadTask.context
Defined in: packages/task/index.ts:88
installJarPath readonly
installJarPath: string
Defined in: packages/installer/forge.ts:147
name
name: string = ''
Inherited from: DownloadTask.name
Defined in: packages/task/index.ts:90
options protected
options: DownloadOptions
Inherited from: DownloadTask.options
Defined in: packages/installer/downloadTask.ts:7
param
param: object = {}
Inherited from: DownloadTask.param
Defined in: packages/task/index.ts:91
parent
parent: undefined | Task<any>
Inherited from: DownloadTask.parent
Defined in: packages/task/index.ts:87
reject protected
reject: Function
Inherited from: DownloadTask.reject
Defined in: packages/task/index.ts:78
resolve protected
resolve: Function
Inherited from: DownloadTask.resolve
Defined in: packages/task/index.ts:77
resultOrError protected
resultOrError: any
Inherited from: DownloadTask.resultOrError
Defined in: packages/task/index.ts:93
🔑 Accessors
from
Inherited from: DownloadTask.from
Defined in: packages/task/index.ts:121
id
Inherited from: DownloadTask.id
Defined in: packages/task/index.ts:116
isCancelled
Inherited from: DownloadTask.isCancelled
Defined in: packages/task/index.ts:124
isDone
Inherited from: DownloadTask.isDone
Defined in: packages/task/index.ts:126
isPaused
Inherited from: DownloadTask.isPaused
Defined in: packages/task/index.ts:125
isRunning
Inherited from: DownloadTask.isRunning
Defined in: packages/task/index.ts:127
path
Inherited from: DownloadTask.path
Defined in: packages/task/index.ts:117
progress
Inherited from: DownloadTask.progress
Defined in: packages/task/index.ts:118
state
Inherited from: DownloadTask.state
Defined in: packages/task/index.ts:122
to
Inherited from: DownloadTask.to
Defined in: packages/task/index.ts:120
total
Inherited from: DownloadTask.total
Defined in: packages/task/index.ts:119
🔧 Methods
_onAborted protected
_onAborted(): void
Return Type
void
Inherited from: DownloadTask._onAborted
Defined in: packages/task/index.ts:226
_onResume protected
_onResume(): void
Return Type
void
Inherited from: DownloadTask._onResume
Defined in: packages/task/index.ts:227
_unpause protected
_unpause(): void
Return Type
void
Inherited from: DownloadTask._unpause
Defined in: packages/task/index.ts:225
cancel
cancel(timeout: number): Promise<void>
Parameters
- timeout:
number
Return Type
Promise<void>
Inherited from: DownloadTask.cancel
Defined in: packages/task/index.ts:145
cancelTask protected
cancelTask(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.cancelTask
Defined in: packages/task/index.ts:233
get
get(): void
Return Type
void
Inherited from: DownloadTask.get
Defined in: packages/task/index.ts:108
isAbortedError protected
isAbortedError(e: any): boolean
Parameters
- e:
any
Return Type
boolean
Inherited from: DownloadTask.isAbortedError
Defined in: packages/installer/downloadTask.ts:47
map
map(transform: Transform<DownloadForgeInstallerTask, N>): Task<N extends Promise<R> ? R : N>
Parameters
- transform:
Transform<DownloadForgeInstallerTask, N>
Return Type
Task<N extends Promise<R> ? R : N>
Inherited from: DownloadTask.map
Defined in: packages/task/index.ts:212
onChildUpdate
onChildUpdate(chunkSize: number): void
Parameters
- chunkSize:
number
Return Type
void
Inherited from: DownloadTask.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
Inherited from: DownloadTask.onProgress
Defined in: packages/installer/downloadTask.ts:13
pause
pause(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.pause
Defined in: packages/task/index.ts:129
pauseTask protected
pauseTask(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.pauseTask
Defined in: packages/task/index.ts:240
process protected
process(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.process
Defined in: packages/installer/downloadTask.ts:20
resume
resume(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.resume
Defined in: packages/task/index.ts:137
resumeTask protected
resumeTask(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.resumeTask
Defined in: packages/task/index.ts:250
runTask protected
runTask(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.runTask
Defined in: packages/task/index.ts:257
setName
setName(name: string, param: object): DownloadForgeInstallerTask
Parameters
- name:
string
- param:
object
Return Type
DownloadForgeInstallerTask
Inherited from: DownloadTask.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: DownloadTask.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: DownloadTask.startAndWait
Defined in: packages/task/index.ts:195
update protected
update(chunkSize: number): void
Parameters
- chunkSize:
number
Return Type
void
Inherited from: DownloadTask.update
Defined in: packages/task/index.ts:200
wait
wait(): Promise<void>
Return Type
Promise<void>
Inherited from: DownloadTask.wait
Defined in: packages/task/index.ts:160