@j-o-r/sh 1.1.19 → 1.1.20

package/lib/SH.js

@@ -107,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();
@@ -163,32 +164,42 @@ const readIn = async () => {
 
 /**
 * Get user input from the command line (stdin)
+* void when input has been aborted
 * @param {string} prompt - prompt or question
-* @returns {Promise<string>}
+* @returns {{input: Promise<string|void>, abort: function(): void}}
 * @example 
-* const content = await userIn();
+* const user = userIn('Question: ');
+* const content = await user.input
+* // user.abort() 
 */
-
-const userIn = (prompt) => new Promise((resolve) => {
+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
-  */
+  /** @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);
-    resolve(fullText);
+    rl.removeAllListeners('line');
+    clearTimeout(timer);
     rl.close();
   };
+
   rl.on('line', (line) => {
     buffer += line + '\n';
     clearTimeout(timer);
@@ -198,8 +209,15 @@ const userIn = (prompt) => new Promise((resolve) => {
 
   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.
 *

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.19",
+  "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

@@ -62,12 +62,18 @@ export function retry(count: number, a: string | number | typeof expBackoff | Fu
 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 {Promise<string>}
+* @returns {{input: Promise<string|void>, abort: function(): void}}
 * @example
-* const content = await userIn();
+* const user = userIn('Question: ');
+* const content = await user.input
+* // user.abort()
 */
-export function userIn(prompt: string): Promise<string>;
+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