multi-progress

multi-progress

This module adds a layer on top of the API of progress that allows for multiple progress bars.

Usage

Install with npm: npm install multi-progress

multi-progress@4 requires progress@2 as a peer dependency. If you don't already have progress@2 as a dependency, add it like so: npm install progress@2.

// require the library
var Multiprogress = require('multi-progress');

// spawn an instance with the optional stream to write to
var multi = new Multiprogress(process.stderr);

// create a progress bar
var bar = multi.newBar('  downloading [:bar] :percent :etas', {
  complete: '=',
  incomplete: ' ',
  width: 30,
  total: size
});

// `bar` is an instance of ProgressBar
// Use the progressbar API with it

More detailed usage examples are available in the following projects:

• rslashimg

Changelog

Version 4.0.0 (2020-10-14)

API changed back to work like v1/v2, no longer having the user pass in Progress to a builder.

Progress is still a peer dependency like with v3, so that users can pick the exact version of progress they wish to use.