@vbarbarosh/node-helpers 3.58.1 → 3.60.0

package/package.json

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

package/src/countdown.js

@@ -1,3 +1,5 @@
+const Promise = require('bluebird');
+
 /**
  * Wait for a promise/value to be settled. Meanwhile, call `tick` function every `tick_ms` milliseconds.
  * After `timeout` seconds, reject with 'Timeout' error.
@@ -10,7 +12,7 @@ function countdown(ctx)
     let done = false;
     let timer = null;
     return new Promise(function (resolve, reject) {
-        ctx.value = Promise.resolve(ctx.value);
+        ctx.value = ctx.fn ? Promise.method(ctx.fn).call() : Promise.resolve(ctx.value);
         ctx.timeout = ctx.timeout || 0;
         ctx.time_now = new Date();
         ctx.time_begin = new Date();

package/src/factorize_ms.js

@@ -0,0 +1,10 @@
+function factorize_ms(v)
+{
+    const h = Math.floor(v / 3600000);
+    const m = Math.floor(v % 3600000 / 60000);
+    const s = Math.floor(v % 60000 / 1000);
+    const ms = v % 1000;
+    return [h, m, s, ms];
+}
+
+module.exports = factorize_ms;

package/src/format_bytes.js

@@ -1,3 +1,6 @@
+/**
+ * @link https://stackoverflow.com/a/18650828
+ */
 function format_bytes(bytes)
 {
     const sizes = ['B', 'KB', 'MB', 'GB', 'TB', 'PB'];
@@ -10,7 +13,7 @@ function format_bytes(bytes)
     if (bytes < 1024) {
         return '1KB';
     }
-    const i = parseInt(Math.floor(Math.log(bytes) / Math.log(1024)), 10);
+    const i = Math.floor(Math.log(bytes) / Math.log(1024));
     return `${(bytes / (1024 ** i)).toFixed(bytes > 1024*1024 ? 2 : 0)}${sizes[i]}`.replace(/\.00/, '.0');
 }
 

package/src/format_ms.js

@@ -0,0 +1,20 @@
+const factorize_ms = require('./factorize_ms');
+
+/**
+ * Format milliseconds
+ */
+function format_ms(ms)
+{
+    if (!ms) {
+        ms = 0;
+    }
+
+    // 00:05
+    const [h, m, s] = factorize_ms(ms);
+    if (h) {
+        return `0${h}:0${m}:0${s}`.replace(/0+(?=\d\d)/g, '');
+    }
+    return `0${m}:0${s}`.replace(/0+(?=\d\d)/g, '');
+}
+
+module.exports = format_ms;

package/src/format_ms.test.js

@@ -0,0 +1,33 @@
+const assert = require('assert');
+const format_ms = require('./format_ms');
+const msval = require('./msval');
+
+const items = [
+    ['00:00', ''],
+    ['00:00', null],
+    ['00:00', undefined],
+    ['00:00', msval(0, 0, 0, 0)],
+    ['00:00', msval(0, 0, 0, 1)],
+    ['00:00', msval(0, 0, 0, 900)],
+    ['00:01', msval(0, 0, 1, 0)],
+    ['00:01', msval(0, 0, 1, 500)],
+    ['00:02', msval(0, 0, 2, 0)],
+    ['00:05', msval(0, 0, 5, 445)],
+    ['01:00', msval(0, 1, 0, 0)],
+    ['12:00', msval(0, 12, 0, 0)],
+    ['12:12', msval(0, 12, 12, 12)],
+    ['01:00:00', msval(1, 0, 0, 0)],
+    ['01:01:00', msval(1, 1, 0, 0)],
+    ['01:01:01', msval(1, 1, 1, 0)],
+    ['01:01:01', msval(1, 1, 1, 1)],
+    ['12:12:12', msval(12, 12, 12, 12)],
+    ['999:00:00', msval(999, 0, 0, 0)],
+];
+
+describe('format_ms', function () {
+    items.forEach(function ([expected, input]) {
+        it(`${input} → ${expected}`, function () {
+            assert.strictEqual(format_ms(input), expected);
+        });
+    });
+});

package/src/format_ms2.js

@@ -0,0 +1,20 @@
+const factorize_ms = require('./factorize_ms');
+
+/**
+ * Format milliseconds
+ */
+function format_ms2(ms)
+{
+    if (!ms) {
+        ms = 0;
+    }
+
+    // 00:05.45
+    const [h, m, s, xx] = factorize_ms(ms);
+    if (h) {
+        return `0${h}:0${m}:0${s}.0${Math.round(xx/10)}`.replace(/0+(?=\d\d)/g, '');
+    }
+    return `0${m}:0${s}.0${Math.round(xx/10)}`.replace(/0+(?=\d\d)/g, '');
+}
+
+module.exports = format_ms2;

package/src/format_ms2.test.js

@@ -0,0 +1,33 @@
+const assert = require('assert');
+const format_ms2 = require('./format_ms2');
+const msval = require('./msval');
+
+const items = [
+    ['00:00.00', ''],
+    ['00:00.00', null],
+    ['00:00.00', undefined],
+    ['00:00.00', msval(0, 0, 0, 0)],
+    ['00:00.00', msval(0, 0, 0, 1)],
+    ['00:00.90', msval(0, 0, 0, 900)],
+    ['00:01.00', msval(0, 0, 1, 0)],
+    ['00:01.50', msval(0, 0, 1, 500)],
+    ['00:02.00', msval(0, 0, 2, 0)],
+    ['00:05.45', msval(0, 0, 5, 445)],
+    ['01:00.00', msval(0, 1, 0, 0)],
+    ['12:00.00', msval(0, 12, 0, 0)],
+    ['12:12.01', msval(0, 12, 12, 12)],
+    ['01:00:00.00', msval(1, 0, 0, 0)],
+    ['01:01:00.00', msval(1, 1, 0, 0)],
+    ['01:01:01.00', msval(1, 1, 1, 0)],
+    ['01:01:01.00', msval(1, 1, 1, 1)],
+    ['12:12:12.01', msval(12, 12, 12, 12)],
+    ['999:00:00.00', msval(999, 0, 0, 0)],
+];
+
+describe('format_ms2', function () {
+    items.forEach(function ([expected, input]) {
+        it(`${input} → ${expected}`, function () {
+            assert.strictEqual(format_ms2(input), expected);
+        });
+    });
+});

package/src/format_ms3.js

@@ -0,0 +1,20 @@
+const factorize_ms = require('./factorize_ms');
+
+/**
+ * Format milliseconds
+ */
+function format_ms3(ms)
+{
+    if (!ms) {
+        ms = 0;
+    }
+
+    // 00:05.445
+    const [h, m, s, xx] = factorize_ms(ms);
+    if (h) {
+        return `0${h}:0${m}:0${s}.00${xx}`.replace(/0+(?=\d\d+[:.]|\d\d\d)/g, '');
+    }
+    return `0${m}:0${s}.00${xx}`.replace(/0+(?=\d\d+[:.]|\d\d\d)/g, '')
+}
+
+module.exports = format_ms3;

package/src/format_ms3.test.js

@@ -0,0 +1,33 @@
+const assert = require('assert');
+const format_ms3 = require('./format_ms3');
+const msval = require('./msval');
+
+const items = [
+    ['00:00.000', ''],
+    ['00:00.000', null],
+    ['00:00.000', undefined],
+    ['00:00.000', msval(0, 0, 0, 0)],
+    ['00:00.001', msval(0, 0, 0, 1)],
+    ['00:00.900', msval(0, 0, 0, 900)],
+    ['00:01.000', msval(0, 0, 1, 0)],
+    ['00:01.500', msval(0, 0, 1, 500)],
+    ['00:02.000', msval(0, 0, 2, 0)],
+    ['00:05.445', msval(0, 0, 5, 445)],
+    ['01:00.000', msval(0, 1, 0, 0)],
+    ['12:00.000', msval(0, 12, 0, 0)],
+    ['12:12.012', msval(0, 12, 12, 12)],
+    ['01:00:00.000', msval(1, 0, 0, 0)],
+    ['01:01:00.000', msval(1, 1, 0, 0)],
+    ['01:01:01.000', msval(1, 1, 1, 0)],
+    ['01:01:01.001', msval(1, 1, 1, 1)],
+    ['12:12:12.012', msval(12, 12, 12, 12)],
+    ['999:00:00.000', msval(999, 0, 0, 0)],
+];
+
+describe('format_ms3', function () {
+    items.forEach(function ([expected, input]) {
+        it(`${input} → ${expected}`, function () {
+            assert.strictEqual(format_ms3(input), expected);
+        });
+    });
+});

package/src/fs_append.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-function fs_append(file, data, options = {})
+function fs_append(file, data, options)
 {
     return fs.promises.appendFile(file, data, options);
 }

package/src/fs_append_utf8.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-function fs_append_utf8(file, text, options = {})
+function fs_append_utf8(file, text, options)
 {
     return fs.promises.appendFile(file, text, options);
 }

package/src/fs_copy.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.copyFile);
+function fs_copy(src, dest, mode)
+{
+    return fs.promises.copyFile(src, dest, mode);
+}
+
+module.exports = fs_copy;

package/src/fs_exists.js

@@ -3,9 +3,7 @@ const fs = require('fs');
 async function fs_exists(path)
 {
     return new Promise(function (resolve) {
-        fs.access(path, function (error) {
-            error ? resolve(false) : resolve(true);
-        });
+        fs.access(path, error => resolve(!error));
     });
 }
 

package/src/fs_lstat.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.lstat);
+function fs_lstat(path, options)
+{
+    return fs.promises.lstat(path, options);
+}
+
+module.exports = fs_lstat;

package/src/fs_mkdir.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.mkdir);
+function fs_mkdir(path, options)
+{
+    return fs.promises.mkdir(path, options);
+}
+
+module.exports = fs_mkdir;

package/src/fs_mkdirp.js

@@ -6,7 +6,7 @@ async function fs_mkdirp(pathname)
 {
     const parents = [];
 
-    for (let p = pathname; p && p != '/'; p = fs_path_dirname(p)) {
+    for (let p = pathname; p && p !== '/'; p = fs_path_dirname(p)) {
         if (await fs_exists(p)) {
             break;
         }

package/src/fs_read.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.readFile);
+function fs_read(path, options)
+{
+    return fs.promises.readFile(path, options);
+}
+
+module.exports = fs_read;

package/src/fs_read_stream.js

@@ -1,3 +1,8 @@
 const fs = require('fs');
 
-module.exports = fs.createReadStream;
+function fs_read_stream(path, options)
+{
+    return fs.createReadStream(path, options);
+}
+
+module.exports = fs_read_stream;

package/src/fs_readdir.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.readdir);
+function fs_readdir(path, options)
+{
+    return fs.promises.readdir(path, options);
+}
+
+module.exports = fs_readdir;

package/src/fs_rm.js

@@ -1,18 +1,11 @@
-const Promise = require('bluebird');
 const fs = require('fs');
 
 /**
  * Remove a file
- *
- * @link https://nodejs.org/api/fs.html#fsunlinkpath-callback
  */
-async function fs_rm(filename)
+function fs_rm(path)
 {
-    await new Promise(function (resolve, reject) {
-        fs.unlink(filename, function (error) {
-            error ? reject(error) : resolve();
-        });
-    });
+    return fs.promises.unlink(path);
 }
 
 module.exports = fs_rm;

package/src/fs_rmdir.js

@@ -1,5 +1,8 @@
 const fs = require('fs');
-const util = require('util');
 
-// https://nodejs.org/api/util.html#util_util_promisify_original
-module.exports = util.promisify(fs.rmdir);
+function fs_rmdir(path)
+{
+    return fs.promises.rmdir(path);
+}
+
+module.exports = fs_rmdir;

package/src/fs_rmf.js

@@ -1,13 +1,17 @@
-const fs_exists = require('./fs_exists');
 const fs_rm = require('./fs_rm');
 
 /**
  * Remove the file if it exists.
  */
-async function fs_rmf(filename)
+async function fs_rmf(path)
 {
-    if (await fs_exists(filename)) {
-        await fs_rm(filename);
+    try {
+        await fs_rm(path);
+    }
+    catch (error) {
+        if (error.code !== 'ENOENT') {
+            throw error;
+        }
     }
 }
 

package/src/fs_rmrf.js

@@ -1,5 +1,5 @@
 const Promise = require('bluebird');
-const fs_fi = require('./fs_fi');
+const fs_lstat = require('./fs_lstat');
 const fs_path_resolve = require('./fs_path_resolve');
 const fs_readdir = require('./fs_readdir');
 const fs_rm = require('./fs_rm');
@@ -8,20 +8,20 @@ const fs_rmdir = require('./fs_rmdir');
 /**
  * Remove a file or directory, along with all nested files and directories, recursively.
  */
-async function fs_rmrf(pathname)
+async function fs_rmrf(path)
 {
-    const fi = await fs_fi(pathname).catch(() => null);
-    if (fi === null) {
+    const lstat = await fs_lstat(path).catch(() => null);
+    if (lstat === null) {
         return;
     }
 
-    if (fi.isDirectory()) {
-        const names = await fs_readdir(pathname);
-        await Promise.all(names.map(v => fs_rmrf(fs_path_resolve(pathname, v))));
-        await fs_rmdir(fi.pathname);
+    if (lstat.isDirectory()) {
+        const names = await fs_readdir(path);
+        await Promise.all(names.map(v => fs_rmrf(fs_path_resolve(path, v))));
+        await fs_rmdir(path);
     }
     else {
-        await fs_rm(fi.pathname);
+        await fs_rm(path);
     }
 }
 

package/src/fs_write.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-async function fs_write(file, data, options = {})
+function fs_write(file, data, options)
 {
     return fs.promises.writeFile(file, data, options);
 }

package/src/fs_write_json.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-async function fs_write_json(file, data)
+function fs_write_json(file, data)
 {
     return fs.promises.writeFile(file, JSON.stringify(data, null, 4));
 }

package/src/fs_write_stream.js

@@ -1,3 +1,8 @@
 const fs = require('fs');
 
-module.exports = fs.createWriteStream;
+function fs_write_stream(path, options)
+{
+    return fs.createWriteStream(path, options);
+}
+
+module.exports = fs_write_stream;

package/src/msval.js

@@ -0,0 +1,6 @@
+function msval(h, m, s, ms)
+{
+    return h*3600000 + m*60000 + s*1000 + ms;
+}
+
+module.exports = msval;

package/src/object_defaults.js

@@ -0,0 +1,11 @@
+function object_defaults(obj, defaults)
+{
+    Object.entries(defaults).forEach(function ([key, value]) {
+        if (obj[key] === undefined) {
+            obj[key] = value;
+        }
+    });
+    return obj;
+}
+
+module.exports = object_defaults;

package/src/stream_progress.js

@@ -6,14 +6,19 @@ const stream = require('stream');
 /**
  * Monitor the progress of data through a pipe, similar to the UNIX `pv` command.
  *
+ * Requirements:
+ * - should emit first message as fast as possible
+ * - should always emit 100% message
+ *
  * @similar https://www.npmjs.com/package/progress-stream
  */
-function stream_progress({objectMode = false, total, user_friendly_status = s => console.log(s)} = {})
+function stream_progress({objectMode = false, interval = 1000, total, user_friendly_status = s => console.log(s)} = {})
 {
     let done = 0;
-    const timer = setInterval(tick, 1000);
+    const timer = setInterval(tick, interval);
     const progress = make_progress(total);
     const format_progress = objectMode ? format_progress_kilo : format_progress_bytes;
+    setTimeout(tick, 0);
     return new stream.Transform({
         objectMode,
         destroy: function (error, callback) {