@types/cli-progress

Single Progress Bar

This feature allows you to create and manage a single progress bar. The code sample demonstrates how to initialize, update, and stop a progress bar.

import { SingleBar } from 'cli-progress';

const bar = new SingleBar({});
bar.start(100, 0);

// Update the current value in your application.
bar.update(50);

// Stop the progress bar when done.
bar.stop();

Multi Progress Bar

This feature enables the management of multiple progress bars simultaneously. The code sample shows how to create multiple progress bars and update them independently.

import { MultiBar } from 'cli-progress';

const multi = new MultiBar({});
const bar1 = multi.create(100, 0);
const bar2 = multi.create(200, 0);

// Update the bars independently
bar1.update(50);
bar2.update(150);

// Stop all bars
multi.stop();

Custom Bar Styles

This feature allows for the customization of the progress bar's appearance, including the complete and incomplete characters and the format of the bar. The code sample demonstrates how to customize these aspects.

import { SingleBar } from 'cli-progress';

const bar = new SingleBar({
  barCompleteChar: '#',
  barIncompleteChar: '.',
  format: 'custom |' + '{bar}' + '| {percentage}%'
});
bar.start(100, 0);
bar.update(55);
bar.stop();