progressbar

A nice wrapper around [TJ Holowaychuck's](https://github.com/visionmedia) [node-progress](https://github.com/visionmedia/node-progress) with chaining, domains, and steps

npm install progressbar
53 downloads in the last day
532 downloads in the last week
2 855 downloads in the last month

Progress Bar

Build Status NPM version Gittip donate button Flattr donate button PayPayl donate button

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

Install

Node, Browserify

  • Use: require('progressbar')
  • Install: npm install --save progressbar

Ender

  • Use: require('progressbar')
  • Install: ender add progressbar

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

Discover the change history by heading on over to the History.md file.

Contribute

Discover how you can contribute by heading on over to the Contributing.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gittip donate button Flattr donate button PayPayl donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2013+ Bevry Pty Ltd us@bevry.me (http://bevry.me)

npm loves you