@vbarbarosh/node-helpers 3.21.1 → 3.23.0

package/package.json

@@ -2,7 +2,7 @@
     "author": "Vladimir Barbarosh <vladimir.barbarosh@gmail.com>",
     "license": "MIT",
     "name": "@vbarbarosh/node-helpers",
-    "version": "3.21.1",
+    "version": "3.23.0",
     "description": "A set of helpers for JavaScript/Node.js",
     "files": [
         "src"

package/src/format_progress.js

@@ -1,15 +1,22 @@
 const format_bytes = require('./format_bytes');
 const format_percents = require('./format_percents');
 const format_seconds = require('./format_seconds');
+const is_number_gt = require('./is_number_gt');
 
 function format_progress({percents, total, done, rate, eta, duration})
 {
-    const bps = rate ? `${format_bytes(rate)}/s` : '~';
-    if (total) {
-        const eta_str = eta ? format_seconds(eta) : '~';
+    const bps = is_number_gt(rate, 0) ? `${format_bytes(rate)}/s` : '~';
+    if (is_number_gt(total, 0)) {
+        const eta_str = is_number_gt(eta, 0) ? format_seconds(eta) : '~';
         return `${format_percents(percents)} | ${format_bytes(done)} of ${format_bytes(total)} at ${bps} ETA ${eta_str} duration=${format_seconds(duration)}`;
     }
-    return `${format_bytes(done)} of ~ at ${bps} duration=${format_seconds(duration)}`;
+    if (is_number_gt(done, 0)) {
+        return `${format_bytes(done)} of ~ at ${bps} duration=${format_seconds(duration)}`;
+    }
+    if (is_number_gt(duration, 0)) {
+        return `~ duration=${format_seconds(duration)}`;
+    }
+    return '~';
 }
 
 module.exports = format_progress;

package/src/format_progress.test.js

@@ -0,0 +1,17 @@
+const assert = require('assert');
+const format_progress = require('./format_progress');
+
+const items = [
+    ['~', {percents: 0, total: 0, done: 0, rate: 0, eta: 0, duration: 0}],
+    ['~ duration=00:00:01', {percents: 0, total: 0, done: 0, rate: 0, eta: 0, duration: 1}],
+    ['25.25% | 5.0MB of 15.0MB at ~ ETA ~ duration=00:00:01', {percents: 0.2525, total: 15*1024*1024, done: 5*1024*1024, rate: 0, eta: 0, duration: 1}],
+    ['25.25% | 5.0MB of 15.0MB at 10.0MB/s ETA 00:00:05 duration=00:00:01', {percents: 0.2525, total: 15*1024*1024, done: 5*1024*1024, rate: 10*1024*1024, eta: 5, duration: 1}],
+];
+
+describe('format_progress', function () {
+    items.forEach(function ([expected, input]) {
+        it(expected, function () {
+            assert.strictEqual(format_progress(input), expected);
+        });
+    });
+});

package/src/http_get_stream.js

@@ -1,10 +1,12 @@
 const axios = require('axios');
+const make_int = require('./make_int');
 
 async function http_get_stream(url, options)
 {
     const res = await axios.get(url, {responseType: 'stream', ...options});
     const out = res.data;
     out.headers = res.headers;
+    out.total = make_int(res.headers['content-length'], null, 0);
     return out;
 }
 

package/src/http_get_stream_range.js

@@ -9,6 +9,7 @@ async function http_get_stream_range(url, first, last)
     const headers = {Range: `bytes=${a}-${b}`};
     const res = await axios.get(url, {responseType: 'stream', headers});
     const out = res.data;
+    out.headers = res.headers;
     if (res.headers['content-range']) {
         out.content_range = parse_http_content_range(res.headers['content-range']);
     }
@@ -22,6 +23,7 @@ async function http_get_stream_range(url, first, last)
     else if (b && out.content_range.last !== b) {
         out.destroy(new Error(`Last byte of a returned range (${format_thousands(out.content_range.last)}) is not as expected: [${format_thousands(b)}]`));
     }
+    out.total = out.content_range.total;
     return out;
 }
 

package/src/is_number.js

@@ -0,0 +1,6 @@
+function is_number(value)
+{
+    return (typeof value === 'number') && isFinite(value);
+}
+
+module.exports = is_number;

package/src/is_number.test.js

@@ -0,0 +1,20 @@
+const assert = require('assert');
+const is_number = require('./is_number');
+
+const items = [
+    ['-inf → false', -Infinity, false],
+    ['+inf → false', +Infinity, false],
+    ['null → false', null, false],
+    ['{} → false', {}, false],
+    ['Symbol() → false', Symbol(), false],
+    ['Function → false', () => 1, false],
+    ['BigInt(1) → false', 1n, false],
+];
+
+describe('is_number', function () {
+    items.forEach(function ([title, input, expected]) {
+        it(title, function () {
+            assert.deepStrictEqual(is_number(input), expected);
+        });
+    });
+});

package/src/is_number_gt.js

@@ -0,0 +1,8 @@
+const is_number = require('./is_number');
+
+function is_number_gt(value, min)
+{
+    return is_number(value) && value > min;
+}
+
+module.exports = is_number_gt;

package/src/make_int.js

@@ -0,0 +1,15 @@
+function make_int(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
+{
+    switch (typeof value) {
+    case 'bigint':
+        return Math.max(min, Math.min(max, Number(value)));
+    case 'symbol':
+        return default_value;
+    }
+    if (value === null || value === undefined || !isFinite(value)) {
+        return default_value;
+    }
+    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
+}
+
+module.exports = make_int;

package/src/make_number.js

@@ -0,0 +1,15 @@
+function make_number(value, default_value = 0, min = Number.MIN_SAFE_INTEGER, max = Number.MAX_SAFE_INTEGER)
+{
+    switch (typeof value) {
+    case 'bigint':
+        return Number(value);
+    case 'symbol':
+        return default_value;
+    }
+    if (value === null || value === undefined || !isFinite(value)) {
+        return default_value;
+    }
+    return Math.max(min, Math.min(max, Math.round(value === 0 ? value : (+value||default_value))));
+}
+
+module.exports = make_number;

package/src/make_number.test.js

@@ -0,0 +1,20 @@
+const assert = require('assert');
+const make_number = require('./make_number');
+
+const items = [
+    ['-inf → 0', -Infinity, 0],
+    ['+inf → 0', +Infinity, 0],
+    ['null → 0', null, 0],
+    ['{} → 0', {}, 0],
+    ['Symbol() → 0', Symbol(), 0],
+    ['Function → 0', () => 1, 0],
+    ['BigInt(1) → 1', 1n, 1],
+];
+
+describe('make_number', function () {
+    items.forEach(function ([title, input, expected]) {
+        it(title, function () {
+            assert.deepStrictEqual(make_number(input), expected);
+        });
+    });
+});