@j-o-r/sh 1.1.18 → 1.1.20

package/lib/SH.js

@@ -27,6 +27,7 @@
 // Modified by: jorrit.duin+sh[AT]gmail.com
 /** @type {assert} */
 import assert from 'node:assert';
+import readline from 'node:readline/promises';
 import SHDispatch from './SHDispatch.js';
 import Test from './Test.js'
 import AsyncTracker from './AsyncTracker.js'
@@ -106,6 +107,7 @@ const SH = new Proxy(function(pieces, ...args) {
 		let s;
 		
 		if (Array.isArray(args[i])) {
+			// @ts-ignore
 			s = args[i].map(/** @param {string} x */(x) => {
 				// Trim every element
 				let str = String(x).trim();
@@ -147,7 +149,7 @@ const within = async (callback) => {
 * This function reads the standard input (stdin) from the current process.
 * @returns {Promise<string>}
 * @example 
-* const content = await stdin();
+* const content = await readIn();
 */
 const readIn = async () => {
 	if (process.stdin.isTTY) return '';   // nothing was piped
@@ -159,6 +161,63 @@ const readIn = async () => {
 	return buf;
 }
 
+
+/**
+* Get user input from the command line (stdin)
+* void when input has been aborted
+* @param {string} prompt - prompt or question
+* @returns {{input: Promise<string|void>, abort: function(): void}}
+* @example 
+* const user = userIn('Question: ');
+* const content = await user.input
+* // user.abort() 
+*/
+const userIn = (prompt) => {
+  let resolvePromise;
+  const input = new Promise((resolve) => { resolvePromise = resolve; });
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  let buffer = '';
+  let timer;
+  /** @param {string} chunk */
+  const onData = (chunk) => {
+    if (chunk.length > 4 && chunk.includes('\n')) {
+      clearTimeout(timer);
+      timer = setTimeout(resolveFunc, 50);
+    }
+  };
+
+  const resolveFunc = () => {
+    let fullText = buffer;
+    if (rl.line) fullText += rl.line;
+    cleanup();
+    resolvePromise(fullText);
+  };
+
+  const cleanup = () => {
+    process.stdin.removeListener('data', onData);
+    rl.removeAllListeners('line');
+    clearTimeout(timer);
+    rl.close();
+  };
+
+  rl.on('line', (line) => {
+    buffer += line + '\n';
+    clearTimeout(timer);
+    timer = setTimeout(resolveFunc, 50);
+  });
+  process.stdin.on('data', onData);
+
+  rl.setPrompt(prompt);
+  rl.prompt();
+
+  return {
+    input,
+    abort: () => {
+      cleanup();
+      resolvePromise();
+    }
+  };
+};
 /**
 * Retries a given asynchronous function a specified number of times with optional delays between attempts.
 *
@@ -308,6 +367,7 @@ export {
 	sleep,
 	retry,
 	readIn,
+	userIn,
 	within,
 	expBackoff,
 	parseArgs,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@j-o-r/sh",
   "author": "Jorrit Duin <j-o-r@duin.work>",
   "type": "module",
-  "version": "1.1.18",
+  "version": "1.1.20",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",

package/types/SH.d.ts

@@ -57,10 +57,24 @@ export function retry(count: number, a: string | number | typeof expBackoff | Fu
 * This function reads the standard input (stdin) from the current process.
 * @returns {Promise<string>}
 * @example
-* const content = await stdin();
+* const content = await readIn();
 */
 export function readIn(): Promise<string>;
 /**
+* Get user input from the command line (stdin)
+* void when input has been aborted
+* @param {string} prompt - prompt or question
+* @returns {{input: Promise<string|void>, abort: function(): void}}
+* @example
+* const user = userIn('Question: ');
+* const content = await user.input
+* // user.abort()
+*/
+export function userIn(prompt: string): {
+    input: Promise<string | void>;
+    abort: () => void;
+};
+/**
 * Create a async/sync context in new execution callstack
 * @param {function} callback - async/sync function
 * @example