Class Progress

Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.

Hierarchy (view full)

UxBase
- Progress

Index

Constructors

Properties

Methods

finish setTotal start stop update

Constructors

constructor

new Progress(outputEnabled): Progress
Parameters
- outputEnabled: boolean
Returns Progress
Overrides UxBase.constructor
- Defined in src/ux/progress.ts:32

Properties

`Readonly`outputEnabled

outputEnabled: boolean

Methods

finish

finish(payload?): void
Update the progress bar with the final number and stop it.
Parameters
- payload: {} = {}
Returns void
- Defined in src/ux/progress.ts:80

setTotal

setTotal(total): void
Set the total number of expected components.
Parameters
- total: number
Returns void
- Defined in src/ux/progress.ts:39

start

start(total, payload?, options?): void
Start the progress bar.
Parameters
- total: number
- payload: Payload = {}
- options: Partial<Options> = Progress.DEFAULT_OPTIONS
Returns void
- Defined in src/ux/progress.ts:47

stop

stop(): void
Stop the progress bar.

Returns void
- Defined in src/ux/progress.ts:90

update

update(num, payload?): void
Update the progress bar.
Parameters
- num: number
- payload: {} = {}
Returns void
- Defined in src/ux/progress.ts:73