Class SDKProgress

Class for tracking progress of asynchronous tasks in the SDK.

Index

Constructors

Properties

numTasks onPhaseUpdated onTaskCompleted onTasksAdded phase

Methods

addTask addTasks completeTask setPhase

Constructors

constructor

new SDKProgress(): SDKProgress
Returns SDKProgress
- Defined in packages/sdk/src/base/core/SDKProgress.ts:15

Properties

numTasks

numTasks: number = 0

onPhaseUpdated

onPhaseUpdated: EventEmitter<SDKProgress, string>

onTaskCompleted

onTaskCompleted: EventEmitter<SDKProgress, number>

onTasksAdded

onTasksAdded: EventEmitter<SDKProgress, number>

phase

phase: string = "Booting example"

Methods

addTask

addTask(): void
Returns void
- Defined in packages/sdk/src/base/core/SDKProgress.ts:22

addTasks

addTasks(count: number): void
Parameters
- count: number
Returns void
- Defined in packages/sdk/src/base/core/SDKProgress.ts:27

completeTask

completeTask(): void
Returns void
- Defined in packages/sdk/src/base/core/SDKProgress.ts:34

setPhase

setPhase(phase: string): void
Parameters
- phase: string
Returns void
- Defined in packages/sdk/src/base/core/SDKProgress.ts:41