Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

progress-bar-formatter

gagle6.1kMIT2.0.1

Progress bar formatter

progress, bar, format

readme

progress-bar-formatter

Progress bar formatter

npm version Travis Coveralls

Example

var ProgressBarFormatter = require('progress-bar-formatter');

var bar = new ProgressBarFormatter();
console.log (bar.format(0.4));
// ##########··············

Formatter([options])

Options:

  • complete - String
    The character that shows completion progress. Default is #.
  • incomplete - String
    The character that shows the remaining progress. Default is ·.
  • length - Number
    The length of the progress bar. Default is 24.

Formatter#format(progress) : String

Formats the progress bar. progress is a number between 0 and 1.

changelog

v2.0.1 (11 Jan 2015) Bump version.

v2.0.0 (11 Jan 2015) Removed "create()". The constructor is now exported.

v1.0.0 (01 Jan 2014) Bump version.

v0.0.1 (05 Dec 2013) First release.