progressbar

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

Progress Bar

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

Node, Browserify

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

Ender

  • Use: require('progressbar')
  • Install: ender add progressbar
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();
  • 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

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

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

These amazing people are maintaining this project:

  • Benjamin Lupton b@lupton.cc (https://github.com/balupton)

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

Become a contributor!

Licensed under the incredibly permissive MIT license

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