Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a humanFriendlyRate option to show the download rate in KiB/s format instead of b/s. #191

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ These are keys in the options object you can pass to the progress bar along with
- `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
- `humanFriendlyRate` will show download rate in KB/s insteaf of B/s.

### Tokens

Expand Down Expand Up @@ -97,11 +98,12 @@ 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', {
var bar = new ProgressBar(' downloading [:bar] :rate :percent :etas', {
complete: '=',
incomplete: ' ',
width: 20,
total: len
total: len,
humanFriendlyRate: true
});

res.on('data', function (chunk) {
Expand Down
4 changes: 3 additions & 1 deletion lib/node-progress.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ exports = module.exports = ProgressBar;
* - `renderThrottle` minimum time between updates in milliseconds defaulting to 16
* - `callback` optional function to call when the progress bar completes
* - `clear` will clear the progress bar upon termination
* - `humanFriendlyRate` will show download rate in KB/s insteaf of B/s.
*
* Tokens:
*
Expand Down Expand Up @@ -70,6 +71,7 @@ function ProgressBar(fmt, options) {
this.callback = options.callback || function () {};
this.tokens = {};
this.lastDraw = '';
this.humanFriendlyRate = options.humanFriendlyRate || false;
}

/**
Expand Down Expand Up @@ -145,7 +147,7 @@ ProgressBar.prototype.render = function (tokens, force) {
.replace(':eta', (isNaN(eta) || !isFinite(eta)) ? '0.0' : (eta / 1000)
.toFixed(1))
.replace(':percent', percent.toFixed(0) + '%')
.replace(':rate', Math.round(rate));
.replace(':rate', (this.humanFriendlyRate ? (Math.round(rate) / 1024).toFixed(1) + 'KiB/s' : Math.round(rate) + 'B/s' ));

/* compute the available space (non-zero) for the bar */
var availableSpace = Math.max(0, this.stream.columns - str.replace(':bar', '').length);
Expand Down