ChildProgressBar<P>
Child instance of a progress bar managed by a ProgressBarManager.
Extends
AsyncDisposable
Type Parameters
| Type Parameter | Default type |
|---|---|
P extends object | unknown | unknown |
Properties
dispose()
dispose: () => PromiseLike<void>;
Dispose of the progress bar, removing it from the parent manager.
Returns
PromiseLike<void>
id
id: number;
The unique identifier of the progress bar.
parent
parent: ProgressBarManager;
The parent progress bar manager.
Methods
[asyncDispose]()
[asyncDispose](undefined)
asyncDispose: PromiseLike<void>
Returns
PromiseLike<void>
Inherited from
AsyncDisposable.[asyncDispose]
[asyncDispose](undefined)
asyncDispose: PromiseLike<void>
Returns
PromiseLike<void>
Inherited from
AsyncDisposable.[asyncDispose]
getTotal()
getTotal(): number
Get the total number of steps in the progress bar.
Returns
number
increment()
increment(step, payload)
increment(step?, payload?): void
Increases the current progress value by a specified amount (default +1).
Update payload optionally.
Parameters
| Parameter | Type |
|---|---|
step? | number |
payload? | Partial<BarPayload | P> |
Returns
void
increment(payload)
increment(payload): void
Parameters
| Parameter | Type |
|---|---|
payload | Partial<BarPayload | P> |
Returns
void
markPerformance()
markPerformance(step?): void
Marks the performance of the progress bar.
Parameters
| Parameter | Type |
|---|---|
step? | number |
Returns
void
setTotal()
setTotal(total): void
Set the total number of steps in the progress bar.
Parameters
| Parameter | Type |
|---|---|
total | number |
Returns
void
update()
update(current, payload)
update(current, payload?): void
Sets the current progress value and optionally the payload with values of custom tokens as a second parameter
Parameters
| Parameter | Type |
|---|---|
current | number |
payload? | Partial<BarPayload | P> |
Returns
void
update(payload)
update(payload): void
Parameters
| Parameter | Type |
|---|---|
payload | Partial<BarPayload | P> |
Returns
void