@vbarbarosh/node-helpers 3.42.0 → 3.44.0

package/package.json

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

package/src/format_hrtime.js

@@ -0,0 +1,10 @@
+/**
+ * Return a human-readable representation of hrtime (the return value from `process.hrtime(hrtime0)`).
+ */
+function format_hrtime(hrtime, digits = 6)
+{
+    const [u, v] = hrtime; // process.hrtime(hrtime0)
+    return (u + v/1E9).toFixed(digits) + 's';
+}
+
+module.exports = format_hrtime;

package/src/fs_fopen_update.js

@@ -1,9 +1,10 @@
 const fs_fopen = require('./fs_fopen');
 
-// Main use case is uploading files in chunks. Each time
-// a chunk is uploaded do update a target file. At the end
-// you will have a ready to go file.
-
+/**
+ * The main use case is uploading files in chunks.
+ * Each time a chunk is uploaded, update the target file.
+ * By the end, you will have a ready-to-use file.
+ */
 async function fs_fopen_update(pathname)
 {
     try {
@@ -11,23 +12,22 @@ async function fs_fopen_update(pathname)
         return await fs_fopen(pathname, 'r+');
     }
     catch (error) {
-        if (error.code != 'ENOENT') {
+        if (error.code !== 'ENOENT') {
             throw error;
         }
     }
 
     try {
-        // There is no such a file, try to create it...
+        // There is no such file; try to create it...
         return await fs_fopen(pathname, 'wx');
     }
     catch (error) {
-        if (error.code != 'EEXIST') {
+        if (error.code !== 'EEXIST') {
             throw error;
         }
     }
 
-    // Another process might have already created it, try to
-    // open for updating...
+    // Another process might have already created it; try opening it for updating
     return fs_fopen(pathname, 'r+');
 }
 

package/src/fs_fread.js

@@ -1,15 +1,16 @@
 const fs = require('fs');
-const util = require('util');
-
-// https://nodejs.org/api/util.html#util_util_promisify_original
-const read = util.promisify(fs.read);
-
-// Main use case is for reading chunks of data from file.
 
+/**
+ * The main use case is reading chunks of data from a file.
+ */
 async function fs_fread(fp, buffer, offset = null)
 {
-    const {bytesRead} = await read(fp, buffer, 0, buffer.length, offset);
-    return (bytesRead == buffer.length) ? buffer : buffer.slice(0, bytesRead);
+    const {bytesRead} = await new Promise(function (resolve, reject) {
+        fs.read(fp, buffer, 0, buffer.length, offset, function (error, out) {
+            error ? reject(error) : resolve(out);
+        });
+    });
+    return (bytesRead === buffer.length) ? buffer : buffer.slice(0, bytesRead);
 }
 
 module.exports = fs_fread;

package/src/fs_fwrite.js

@@ -1,14 +1,15 @@
 const fs = require('fs');
-const util = require('util');
-
-// https://nodejs.org/api/util.html#util_util_promisify_original
-const write = util.promisify(fs.write);
-
-// Main use case is for writing chunks of data to file.
 
+/**
+ * The main use case is writing chunks of data to a file.
+ */
 async function fs_fwrite(fp, buffer, offset = null)
 {
-    const {bytesWritten} = await write(fp, buffer, 0, buffer.length, offset);
+    const {bytesWritten} = await new Promise(function (resolve, reject) {
+        fs.write(fp, buffer, 0, buffer.length, offset, function (error, out) {
+            error ? reject(error) : resolve(out);
+        });
+    });
     return bytesWritten;
 }
 

package/src/fs_read_buffer.js

@@ -1,5 +1,8 @@
 const fs_read = require('./fs_read');
 
+/**
+ * Read the entire contents of a file into a buffer.
+ */
 function fs_read_buffer(file)
 {
     return fs_read(file);

package/src/fs_read_utf8.js

@@ -1,5 +1,8 @@
 const fs_read = require('./fs_read');
 
+/**
+ * Read the entire contents of a file into a UTF-8 encoded string.
+ */
 function fs_read_utf8(file)
 {
     return fs_read(file, {encoding: 'utf8'});

package/src/fs_rmrf.js

@@ -5,6 +5,9 @@ const fs_readdir = require('./fs_readdir');
 const fs_rm = require('./fs_rm');
 const fs_rmdir = require('./fs_rmdir');
 
+/**
+ * Remove a file or directory, along with all nested files and directories, recursively.
+ */
 async function fs_rmrf(pathname)
 {
     const fi = await fs_fi(pathname).catch(() => null);

package/src/fs_size_enoent.js

@@ -1,10 +1,8 @@
 const fs = require('fs');
 
 /**
- * Returns size of a file, or 0 if file is not present. Was created for cases
- * when you need to resume download.
- *
- * @returns {Promise<int>}
+ * Returns the size of a file, or 0 if the file is not present.
+ * It was created for cases when you need to resume a download.
  */
 async function fs_size_enoent(path)
 {

package/src/perf_end_human.js

@@ -0,0 +1,8 @@
+const format_hrtime = require('./format_hrtime');
+
+function perf_end_human(time0, digits = 4)
+{
+    return format_hrtime(process.hrtime(time0), digits);
+}
+
+module.exports = perf_end_human;

package/src/perf_end_ms.js

@@ -0,0 +1,7 @@
+function perf_end_ms(time0)
+{
+    const [u, v] = process.hrtime(time0);
+    return Math.round((u + v/1E9)*1000);
+}
+
+module.exports = perf_end_ms;

package/src/perf_measure_human.js

@@ -0,0 +1,11 @@
+const perf_end_human = require('./perf_end_human');
+const perf_start = require('./perf_start');
+
+async function perf_measure_human(fn, digits = 4)
+{
+    const time0 = perf_start();
+    await fn();
+    return perf_end_human(time0, digits);
+}
+
+module.exports = perf_measure_human;

package/src/perf_start.js

@@ -0,0 +1,6 @@
+function perf_start()
+{
+    return process.hrtime();
+}
+
+module.exports = perf_start;