Class InstallLibraryTask

🏭 Constructors

constructor

InstallLibraryTask(libs: ResolvedLibrary[], folder: MinecraftFolder, options: LibraryOptions): InstallLibraryTask

Parameters

• libs: ResolvedLibrary[]
• folder: MinecraftFolder
• options: LibraryOptions

Return Type

• InstallLibraryTask

Defined in: packages/installer/minecraft.ts:498

🏷️ Properties

_from protected

_from: undefined | string

Inherited from: DownloadMultipleTask._from

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

_id protected

_id: number = 0

Inherited from: DownloadMultipleTask._id

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

_path protected

_path: string = ''

Inherited from: DownloadMultipleTask._path

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

_pausing protected

_pausing: Promise<void> = ...

Inherited from: DownloadMultipleTask._pausing

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

_progress protected

_progress: number = 0

Inherited from: DownloadMultipleTask._progress

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

_promise protected

_promise: Promise<void>

Inherited from: DownloadMultipleTask._promise

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

_state protected

_state: TaskState = TaskState.Idle

Inherited from: DownloadMultipleTask._state

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

_to protected

_to: undefined | string

Inherited from: DownloadMultipleTask._to

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

_total protected

_total: number = -1

Inherited from: DownloadMultipleTask._total

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

context

context: TaskContext = {}

Inherited from: DownloadMultipleTask.context

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

controller protected

controller: undefined | AbortController

Inherited from: DownloadMultipleTask.controller

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

name

name: string = ''

Inherited from: DownloadMultipleTask.name

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

onFinished protected optional

onFinished: (index: number) => void

Inherited from: DownloadMultipleTask.onFinished

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

options protected

options: DownloadOptions[]

Inherited from: DownloadMultipleTask.options

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

param

param: object = {}

Inherited from: DownloadMultipleTask.param

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

parent

parent: undefined | Task

Inherited from: DownloadMultipleTask.parent

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

progresses protected

progresses: number[] = []

Inherited from: DownloadMultipleTask.progresses

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

reject protected

reject: (err: any) => void

Inherited from: DownloadMultipleTask.reject

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

resolve protected

resolve: (value: void) => void

Inherited from: DownloadMultipleTask.resolve

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

resultOrError protected

resultOrError: any

Inherited from: DownloadMultipleTask.resultOrError

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

totals protected

totals: number[] = []

Inherited from: DownloadMultipleTask.totals

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

🔑 Accessors

from

Inherited from: DownloadMultipleTask.from

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

id

Inherited from: DownloadMultipleTask.id

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

isCancelled

Inherited from: DownloadMultipleTask.isCancelled

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

isDone

Inherited from: DownloadMultipleTask.isDone

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

isPaused

Inherited from: DownloadMultipleTask.isPaused

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

isRunning

Inherited from: DownloadMultipleTask.isRunning

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

path

Inherited from: DownloadMultipleTask.path

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

progress

Inherited from: DownloadMultipleTask.progress

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

state

Inherited from: DownloadMultipleTask.state

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

to

Inherited from: DownloadMultipleTask.to

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

total

Inherited from: DownloadMultipleTask.total

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

🔧 Methods

_onAborted protected

_onAborted(): void

Return Type

• void

Inherited from: DownloadMultipleTask._onAborted

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

_onResume protected

_onResume(): void

Return Type

• void

Inherited from: DownloadMultipleTask._onResume

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

_unpause protected

_unpause(): void

Return Type

• void

Inherited from: DownloadMultipleTask._unpause

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

abort protected

abort(isCancelled: boolean): void

Parameters

• isCancelled: boolean

Return Type

• void

Inherited from: DownloadMultipleTask.abort

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

cancel

cancel(timeout: number): Promise<void>

Parameters

• timeout: number

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.cancel

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

cancelTask protected

cancelTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.cancelTask

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

get

get(): void

Return Type

• void

Inherited from: DownloadMultipleTask.get

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

isAbortedError protected

isAbortedError(e: any): boolean

Parameters

• e: any

Return Type

• boolean

Inherited from: DownloadMultipleTask.isAbortedError

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

map

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

Parameters

• transform: Transform<InstallLibraryTask, N>

Return Type

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

Inherited from: DownloadMultipleTask.map

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

onChildUpdate

onChildUpdate(chunkSize: number): void

Parameters

• chunkSize: number

Return Type

• void

Inherited from: DownloadMultipleTask.onChildUpdate

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

pause

pause(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.pause

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

pauseTask protected

pauseTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.pauseTask

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

process protected

process(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.process

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

resume

resume(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.resume

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

resumeTask protected

resumeTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.resumeTask

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

runTask protected

runTask(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.runTask

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

setName

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

Parameters

• name: string
• param: object

Return Type

• InstallLibraryTask

Inherited from: DownloadMultipleTask.setName

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

start

start(context: TaskContext, parent: Task): void

Parameters

• context: TaskContext
• parent: Task

Return Type

• void

Inherited from: DownloadMultipleTask.start

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

startAndWait

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

Parameters

• context: TaskContext
• parent: Task

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.startAndWait

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

update protected

update(chunkSize: number): void

Parameters

• chunkSize: number

Return Type

• void

Inherited from: DownloadMultipleTask.update

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

wait

wait(): Promise<void>

Return Type

• Promise<void>

Inherited from: DownloadMultipleTask.wait

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