Rein's progress bar module

This is a module for easily managing progress bars only. It is recommended to use this in combination with node-draftlog.

Usage:

1const ProgressBar = require("progress_bar");
2
3//Set total tasks needed to fill the bar
4const PB = new ProgressBar(7);
5
6//Do tasks
7
8//Add 3 finished tasks to bar
9PB.add(3);
10
11//Or set it directly
12PB.done = 3
13
14//Log progress bar
15console.log(`${PB.display()} ${PB.percentage()}% \n`)
16
17// [=====================>                            ] 42%

Changing the bar style

Currentlty available styles:

Styles can be set like this: PB.setStyle( styleNumber )

Adding a custom style

Object:

1// A style consists of 5 settings
2// The settings for this: `[===>   ]` bar are used in the example
3// Create an object with the configuration (brackets and indicator may be undefined)
4const customStyle = {
5    openBracket: "[",
6    progress: "=",
7    indicator: ">",
8    left: " " //space,
9    closeBracket: "]"
10}
11
12//Add it to the class
13let i = PB.addStyle(customStyle);
14
15//Use the returned index to set the style
16PB.setStyle( i );

Function:

1//Styles don't have to be objects, the can also be functions.
2//Here we have a style that shows the finished tasks as an indicator
3//Styles can be functions
4
5//Note that "this" will point to the ProgressBar class instance when run
6customStyle = function () {
7    //Copy style number 0
8    let style = this.styles[0];
9    
10    //Edit the indicator to show the number of finished tasks
11    style.indicator = this.done + ">";
12    return style
13}
14//Set the style
15PB.setStyle( PB.addStyle(customStyle) );