2.0.3 • Published 4 years ago

progress v2.0.3

Weekly downloads
15,978,664
License
MIT
Repository
github
Last release
4 years ago

Flexible ascii progress bar.

Installation

$ npm install progress

Usage

First we create a ProgressBar, giving it a format string as well as the total, telling the progress bar when it will be considered complete. After that all we need to do is tick() appropriately.

var ProgressBar = require('progress');

var bar = new ProgressBar(':bar', { total: 10 });
var timer = setInterval(function () {
  bar.tick();
  if (bar.complete) {
    console.log('\ncomplete\n');
    clearInterval(timer);
  }
}, 100);

Options

These are keys in the options object you can pass to the progress bar along with total as seen in the example above.

  • curr current completed index
  • total total number of ticks to complete
  • width the displayed width of the progress bar defaulting to total
  • stream the output stream defaulting to stderr
  • head head character defaulting to complete character
  • complete completion character defaulting to "="
  • incomplete incomplete character defaulting to "-"
  • renderThrottle minimum time between updates in milliseconds defaulting to 16
  • clear option to clear the bar on completion defaulting to false
  • callback optional function to call when the progress bar completes

Tokens

These are tokens you can use in the format of your progress bar.

  • :bar the progress bar itself
  • :current current tick number
  • :total total ticks
  • :elapsed time elapsed in seconds
  • :percent completion percentage
  • :eta estimated completion time in seconds
  • :rate rate of ticks per second

Custom Tokens

You can define custom tokens by adding a {'name': value} object parameter to your method (tick(), update(), etc.) calls.

var bar = new ProgressBar(':current: :token1 :token2', { total: 3 })
bar.tick({
  'token1': "Hello",
  'token2': "World!\n"
})
bar.tick(2, {
  'token1': "Goodbye",
  'token2': "World!"
})

The above example would result in the output below.

1: Hello World!
3: Goodbye World!

Examples

Download

In our download example each tick has a variable influence, so we pass the chunk length which adjusts the progress bar appropriately relative to the total length.

var ProgressBar = require('progress');
var https = require('https');

var req = https.request({
  host: 'download.github.com',
  port: 443,
  path: '/visionmedia-node-jscoverage-0d4608a.zip'
});

req.on('response', function(res){
  var len = parseInt(res.headers['content-length'], 10);

  console.log();
  var bar = new ProgressBar('  downloading [:bar] :rate/bps :percent :etas', {
    complete: '=',
    incomplete: ' ',
    width: 20,
    total: len
  });

  res.on('data', function (chunk) {
    bar.tick(chunk.length);
  });

  res.on('end', function () {
    console.log('\n');
  });
});

req.end();

The above example result in a progress bar like the one below.

downloading [=====             ] 39/bps 29% 3.7s

Interrupt

To display a message during progress bar execution, use interrupt()

var ProgressBar = require('progress');

var bar = new ProgressBar(':bar :current/:total', { total: 10 });
var timer = setInterval(function () {
  bar.tick();
  if (bar.complete) {
    clearInterval(timer);
  } else if (bar.curr === 5) {
      bar.interrupt('this message appears above the progress bar\ncurrent progress is ' + bar.curr + '/' + bar.total);
  }
}, 1000);

You can see more examples in the examples folder.

License

MIT

puppeteer@liuhaomin/testarno-front-clireact-native-bluetooth2killi8n-react-native-fast-image@bonobolabs/firebase-tools-deploy-parallelismschriftlage-clipipihomeoe-puppeteer-platform-targetingvpn-speed-test@darrinholst/cucumberreact-static-jurosh@are1000/anagatsby-source-filesystem-frontmatterreact-npm-boilerhybrix-nodeadgile-dev@nicomee/puppeteerquixxi-cli-testwampanbient-downloaderbraunny-surge@icanpm/api-master@teamsqlio/teamsql-clielectron-eslintbraunny-autolink-cacarotoeslint-4-fixfpackerpstk-clivtex3web-deploy@arisageha/react-lazyload@arisageha/react-lazyload-fix@oneplanetcrowd/developers@stelladoradus/hermes-cliexpositcook-pkg@kibalabs/react-staticslack-middleware-serverdiode-inspr-testdiode-testttdiode-inspr-test-test-testdiode-inspr-testtdiode-testdiode-test-test-diodeinspr-test-diode-testdiode-test-inspr@exenode/react-native-build-cli-toolsinspr-diode-testpsc-tool@almeidaa/msdw-mx-packing-tools@wangxiang/my_musicactionableagileimporttoolsamuelversionpeer-sendwp2ghostinsta-getecp-jobsreact-native-template-rfbasethunisoft-cliimou-cliciic-sonarqube-scanner@rakeshswain16/tangencj-photo-processsaveiggenerator-panesgenerator-panesjsgenerator-amaze@pot-code/novelgenerator-ng-panessy-craftjj-editor-installeralex-project-testyandl@lydev/geticare-vue-type-checkairscanairscan-exampleltypedocradobb-chatstrap-cliyijicolorbarreact-native-esc-pos-sahaabmta-nodesemdsemds@borisovart/atol-kkt-moduletzar-coremockipc@liuli-moe/web-logger-cliffmpegjs-advancedkubii-apialipay-mini-programdeneme323112collider-cli@inspr/diodelets-kissmigrate-githubto-my-girl
2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

5 years ago

1.1.8

8 years ago

1.1.7

8 years ago

1.1.6

8 years ago

1.1.5

8 years ago

1.1.4

8 years ago

1.1.3

8 years ago

1.1.2

9 years ago

1.1.0

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago

0.1.0

10 years ago

0.0.5

10 years ago

0.0.4

11 years ago

0.0.3

11 years ago

0.0.2

11 years ago

0.0.1

11 years ago