@keeex/utils-node

• Gitea
• SonarQube

Provide some reusable functions and classes.

Installation

Installation is done through package manager:

npm install @keeex/utils-node

Usage

Use full path import to access content.

import {shardPath} from "@keeex/utils-node/lib/idx";

Content

This section provides a quick overview of the library's content. All functions are documented using JSDoc-type comments.

/lib/idx.js

• shardPath(): Return a sharded path from an IDX words.

/lib/temp.js

• getTempCopyName(): Return a temporary filename in the same location and with the same suffix as the source path.
• getTempCopyNameSync(): Synchronous verison of getTempCopyName()

/lib/spawn.js

• wrapSpawn(): Wrap a call to node's spawn() function into a promise that will collect content from stdout and stderr and resolve once the process terminate.
• simpleProcess(): Helper to call a process (with optional stdin data fed into it) and retrieve the output as strings.
• spawnLive(): Call to spawn() with live feedback from the running process and promise output.

/lib/password/storage.js

• storePassword(): Create a string to store information for later password validation
• verifyPassword(): Used to compare a previously stored value with a new user-provided value

/lib/streams/buffersink.js

Exports the class BufferSink which is a writeable Node stream that internally writes every input into an Uint8Array. Combined with using pipeline() it makes it easy to get the outcome of a stream sequence. The full output can be retrieved through one of those properties:

• buffer: the raw Uint8Array
• hex: the hexadecimal representation of the buffer
• base64: base64 representation
• utf8: as the utf-8 interpretation of the buffer (this may fail on invalid content).
• ascii: the raw bytes in a string. Avoid using that as it is not efficient.

/lib/daemon.js

Exports handleDaemon(), which either run the daemon task once or schedule it for repetition depending on CLI arguments.

/lib/argv.js

A simpler version of parseargv.

/lib/parseargv.js

Export a parsing class to handle CLI arguments.

/lib/tsgen.js

Generate TypeScript/JavaScript files with import handling.