Class Progress

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

Hierarchy (View Summary)

UxBase
- Progress

Index

Constructors

Properties

Methods

finish setTotal start stop update

Constructors

constructor

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

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 ux/progress.ts:89

setTotal

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

start

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

stop

stop(): void
Stop the progress bar.

Returns void
- Defined in ux/progress.ts:99

update

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