timoxley / progressbar

A nice wrapper around TJ Holowaychuck's node-progress with chaining, domains, and steps

ProgressBar

A nice wrapper around TJ Holowaychuck's node-progress with chaining, domains, and steps

Install

Backend

1. Install Node.js
2. npm install --save progressbar

Frontend

1. See Browserify

Usage

Example

var ProgressBar = require('progressbar').ProgressBar;
var progress = new ProgressBar();
progress
	.step('the task you are currently performing')
	.setTotal(5)
	.setTick(1)
	.setTick(2)
	.setTick(3)
	.addTick()
	.addTick();

ProgressBar API

• step(step) - set the step, resets the total and the tick
• setTick(ticks) - set the completed ticks
• addTick() - add 1 to the completed ticks
• getTick() - get the completed ticks
• setTotal(total) - set the total ticks
• addTotal() - add 1 to the total ticks
• getTotal() - get the total ticks
• finish() - finish manually, will destroy the progress bar

History

You can discover the history inside the History.md file

License

Licensed under the incredibly permissive MIT License
Copyright © 2013+ Bevry Pty Ltd