Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

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

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Progress Bar

Build Status NPM version Dependency Status Development Dependency Status
Gittip donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

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

Install

NPM

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

Usage

Example

require('progressbar').ProgressBar.create()
    .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 BitCoin donate button Wishlist browse 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)

Something went wrong with that request. Please try again.