A infinity progress bar for terminal

Also customizable

You can add header, footer and change every time

Install

npm install cli-infinity-progress

Usage

const CLIInfinityProgress = require('cli-infinity-progress');

const progress = new CLIInfinityProgress();
progress.start();

Methods:

| Name | Return | Desc | | --------------------------------- | ------ | ------------------------------------------------------------------------------ | | .setBarColor(colors.green) | this | Set bar color const colors = require('cli-infinity-progress/colors'); | | .setBackgroundColor(colors.white) | this | Set background color const colors = require('cli-infinity-progress/colors'); | | .setHeader('Header') | this | Set header on top of progress. you can update every time | | .setFooter('Footer') | this | Set footer on bottom of progress. you can update every time | | .setBarChar('🚕') | this | Set bar char | | .setBackgroundChar('-') | this | Set background char | | .setDirectionRightToLeft() | this | Progress start from right default is left | | .setDirectionLeftToRight() | this | Progress start from left | | .setSize(30) | this | Set progress size default is 60 | | .setBarSize(5) | this | Set bar size default is 20 | | .setRefreshRate(80) | this | Set refresh rate default is (1000 / 25)ms | | .start() | this | Start progress | | .remove() | this | Remove progress from terminal | | .stop() | this | Stop progress on terminal | | .pause() | this | Pause progress on terminal | | .resume() | this | Resume progress on terminal |

You can call all methods as chaining ex:

const CLIInfinityProgress = require('cli-infinity-progress');
const colors = require('cli-infinity-progress/colors');

progress
  .setBackgroundColor(colors.yellow)
  .setHeader('Loading ...')
  .setFooter('\nPlease be patient.')
  .setBarChar('🚕')
  .setBackgroundChar('_')
  .setDirectionRightToLeft()
  .setSize(32)
  .setBarSize(1)
  .setRefreshRate(100)
  .start();

setTimeout(() => progress.setFooter('\nWoo, Cab is coming.'), 3000);

Result:

Roadmap