cnp-progress

Flexible node progress bar for Windows/macOS/Linux

Installation

npm install cnp-progress

Quickstart

var { Progress } = require('cnp-progress');

var total = 50,
  count = 0;

var progress = Progress.create({ total: total });

var iv = setInterval(function () {
  count++;
  progress.update();
  if (count == total) {
    clearInterval(iv);
  }
}, 150);

API

create(options)

Creates and returns new progress bar.

update(current?: number, message?: string)

Updates progress.

done()

Finishes progress regardless of progress stage. Optional.

Options

Progress bar accepts the following options on initialisation:

• total: number - Total number of items to process.
• pattern: string - Optional layout pattern, defaults to 'Progress: {bar} | Elapsed: {elapsed} | {percent}'. See Patterns
• textColor: string - Optional text color. See Colors
• title: string - Optional title to display above progress bar.
• updateFrequency: number - Optional update frequency limit in milliseconds. See Update frequency.

// with default options
var progress = Progress.create({ total: 50 });

// with pattern
var progress = Progress.create({
  total: 50,
  pattern: 'Progress: {bar} | Remaining: {remaining} | {percent} ',
});

//with pattern and text color
var progress = Progress.create({
  total: 50,
  pattern:
    'Progress: {current}/{total} | Remaining: {remaining} | Elapsed: {elapsed} ',
  textColor: 'blue',
});

//with default options and title
var progress = Progress.create({ total: 50, title: 'Waiting for results' });

Update frequency

When set limits progress bar update rate. Used to limit refresh rate for quickly running tasks.

In the example below progress bar will only update every 150 milliseconds instead of updating 1000 times every millisecond. This will reduce resource allocation to progress bar.

var { Progress } = require('cnp-progress');

var total = 1000,
  count = 0;

var progress = Progress.create({ total: total, updateFrequency: 150 });

var iv = setInterval(function () {
  count++;
  progress.update();
  if (count == total) {
    clearInterval(iv);
  }
}, 1);

Patterns

The following tokens are supported:

• {bar} - progress bar.
• {elapsed} - elapsed time in seconds.
• {remaining} - estimated remaining time in seconds.
• {percent} - completion percentage
• {memory} - process memory usage in megabytes.
• {current} - current item.
• {total} - total items.
• {message} - message for current update.

Token customisation

Tokens can be customised to define color for each token. Progress bar token accepts two colors for remaining/done items as well as length.

Usage for all tokens except progress bar:

• {token.color}

Usage for progress bar:

• {bar.color.color.length} - default is {bar.white.green.20}

var progress = Progress.create({
  total: 50,
  pattern:
    'Progress: {bar.white.red.10} | Remaining: {remaining.red} | {percent.blue}',
});

Colors

Progress bar uses charm to render elements and supports charm string colors:

• red
• yellow
• green
• blue
• cyan
• magenta
• black
• white