Package Exports
- cli-infinity-progress
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cli-infinity-progress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A infinity progress bar for terminal
Install
npm install cli-infinity-progressUsage
const CLIInfinityProgress = require('cli-infinity-progress');
const progress = new CLIInfinityProgress();
progress.start();Methods:
| Name | Return | Desc |
|---|---|---|
| .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(60) | this | Set progress size default is 60 |
| .setBarSize(20) | this | Set bar size default is 20 |
| .setRefreshRate(1000 / 25) | 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 |
You can call all methods as chaining ex:
progress
.setBarChar('🚕')
.setBackgroundChar('_')
.setDirectionRightToLeft()
.setSize(30)
.setBarSize(1)
.setRefreshRate(100)
.start();Result:
Road map:
- add prefix and postfix on progress
- set prefix and postfix color
- set bar color
- set background color
- add an event when indicator arrived to end
- prevent change some values at running
- decrease size
- add pause and resume methods
- add specific loop count