Skip to main content

CreateCLIProgressBarOptions

Properties​

displayName?​

optional displayName: null | PathBuilderLike;

The display name of the progress bar.

etaBuffer?​

optional etaBuffer: number;

Number of updates to the progress bar before the ETA is recalculated.

id?​

optional id: number;

showCount?​

optional showCount: boolean;

Whether to show the completion count in the progress bar.

showDuration?​

optional showDuration: boolean;

Whether to show the duration of the progress bar.

showETA?​

optional showETA: boolean;

Whether to show the estimated time of arrival of the progress bar.

showPerformance?​

optional showPerformance: boolean;

Whether to show performance metrics in the progress bar.

total?​

optional total: number;

The total number of steps in the progress bar.

This is the maximum value of the progress bar, and denominates the total number of steps that will be taken to complete the task.

value?​

optional value: number;

The initial value of the progress bar.

Default​

0