Add detailed eta

Readme.md

@@ -51,6 +51,7 @@ These are tokens you can use in the format of your progress bar.
 - `:elapsed` time elapsed in seconds
 - `:percent` completion percentage
 - `:eta` estimated completion time in seconds
+- `:veta` (verbose eta) estimated completion time in hours, minutes and seconds
 - `:rate` rate of ticks per second
 
 ### Custom Tokens

examples/veta.js

@@ -0,0 +1,23 @@
+var ProgressBar = require("..");
+
+// Demonstrates the use of custom tokens with verbose eta
+
+var list = Array(10000)
+  .fill(0)
+  .map((_, i) => `image_${i + 1}.jpg`);
+
+var bar = new ProgressBar(
+  ":percent eta: :veta downloading :current/:total :file",
+  {
+    total: list.length,
+  }
+);
+
+var id = setInterval(function () {
+  bar.tick({
+    file: list[bar.curr],
+  });
+  if (bar.complete) {
+    clearInterval(id);
+  }
+}, 500);

lib/node-progress.js

@@ -137,13 +137,23 @@ ProgressBar.prototype.render = function (tokens, force) {
   var eta = (percent == 100) ? 0 : elapsed * (this.total / this.curr - 1);
   var rate = this.curr / (elapsed / 1000);
 
+  var eta_s = eta / 1000;
+  var h = Math.floor(eta_s / 3600);
+  var m = Math.floor((eta_s % 3600) / 60);
+  var s = Math.floor((eta_s % 3600) % 60);
+
+  var hDisplay = h > 0 ? h + (h == 1 ? " hour, " : " hours, ") : "";
+  var mDisplay = m > 0 ? m + (m == 1 ? " minute, " : " minutes, ") : "";
+  var sDisplay = s > 0 ? s + (s == 1 ? " second" : " seconds") : "";
+
   /* populate the bar template with percentages and timestamps */
   var str = this.fmt
     .replace(':current', this.curr)
     .replace(':total', this.total)
     .replace(':elapsed', isNaN(elapsed) ? '0.0' : (elapsed / 1000).toFixed(1))
     .replace(':eta', (isNaN(eta) || !isFinite(eta)) ? '0.0' : (eta / 1000)
       .toFixed(1))
+    .replace(':veta', hDisplay + mDisplay + sDisplay)
     .replace(':percent', percent.toFixed(0) + '%')
     .replace(':rate', Math.round(rate));