@j-o-r/sh 1.0.6 → 1.0.8

package/lib/SHDispatch.js

@@ -18,6 +18,7 @@ import SHExec from './SHExecute.js';
  * @property {string} [prefix] - The prefix commands to ensure a safe execution environment. e.g: prefix: 'set -euo pipefail;/usr/bin/env',
  * @property {StdioOptions|StdioOption} [stdio] - The stdio configuration.
  * @property {number} [timeout] - default 20000: a timeout error is triggerd when a process execution time is exceeded, 0 is no timeout
+ * @property {boolean} [detached] - default false, when true it runnes as a background process  
  */
 /**
  * @typedef {('pipe' | 'ignore' | 'inherit' | number)} StdioOption
@@ -86,6 +87,7 @@ const defaultOptions = {
 	cwd: process.cwd(),
 	env: process.env,
 	shell: 'bash',
+	detached: false,
 	prefix: '/usr/bin/env',
 	stdio: ['inherit', 'pipe', 'pipe'],
 	timeout: 10000 // when 0 there is no timeout
@@ -140,11 +142,11 @@ class SHDispatch {
 		// @ts-ignore
 		return new SHExec(this.#cmd, this.#options).runSync(payload);
 	}
-	async kill() {
-		try {
-			await this.#proc.kill();
-		} catch (_e) { }
+	async kill(signal = 'SIGTERM') {
+		let res = [];
+		res = await this.#proc.kill(signal);
 		this.#proc = undefined;
+		return res;
 	}
 }
 

package/lib/SHExecute.js

@@ -20,7 +20,7 @@ const killProcesses = (processPid, signal) => {
 				reject(new Error(stderr));
 				return;
 			}
-			const pids = stdout.split(/\r?\n/).filter(pid => pid);
+			const pids = stdout.split(/\r?\n/).filter(pid => pid) || [];
 			// Kill each child process
 			try {
 				for (const pid of pids) {
@@ -48,6 +48,7 @@ class SHExecute {
 	/**
 	* @type {import('child_process').ChildProcess}
 	*/
+	#forcedKill = false;
 	#proc;
 	#command = '';
 	#options = {};
@@ -72,7 +73,7 @@ class SHExecute {
 		if (payload && typeof payload !== 'string') {
 			throw new Error('Argument is not a string');
 		}
-		let { cwd, shell, env, stdio } = this.#options;
+		let { cwd, shell, env, stdio, detached } = this.#options;
 		// pipe need to be set on stdin when posting a payload
 		if (payload) stdio[0] = 'pipe';
 		const input = payload || undefined;
@@ -80,6 +81,7 @@ class SHExecute {
 			cwd,
 			shell,
 			stdio,
+			detached,
 			windowsHide: true,
 			env,
 			input
@@ -127,6 +129,11 @@ class SHExecute {
 			}
 			this.#proc.on('close', (code) => {
 				if (timeout) clearTimeout(timeout);
+				if (this.#forcedKill) {
+					// Resolve without content
+					resolve();
+					return;
+				}
 				if (code === 0) {
 					resolve(this.#stdout.trim());
 				} else {
@@ -140,13 +147,26 @@ class SHExecute {
 		});
 	}
 	/**
+	* Kill this process and possible child processes
+	* @param {string} signal - kill signal
 	* @returns {Promise<number[]>}
 	*/
 	async kill(signal = 'SIGTERM') {
 		if (!this.#proc) throw new Error('Trying to kill a process without creating one.');
 		if (!this.#proc.pid) throw new Error('The process pid is undefined.');
-
-		return killProcesses(this.#proc.pid, signal);
+		this.#forcedKill = true;
+		let res = [];
+		try {
+			// Try to kill pid 'childs'
+			res = await killProcesses(this.#proc.pid, signal);
+		} catch (_e) { }
+		if (!res.includes(this.#proc.pid)) {
+			// Kill self if I am not allready killed
+			res.push(this.#proc.pid);
+			this.#proc.kill(signal);
+		}
+		this.#proc = undefined;
+		return res;
 	}
 }
 

package/package.json

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

package/types/SHDispatch.d.ts

@@ -53,6 +53,10 @@ export type SHOptions = {
      * - default 20000: a timeout error is triggerd when a process execution time is exceeded, 0 is no timeout
      */
     timeout?: number | undefined;
+    /**
+     * - default false, when true it runnes as a background process
+     */
+    detached?: boolean | undefined;
 };
 export type StdioOption = ("pipe" | "ignore" | "inherit" | number);
 export type StdioOptions = Array<StdioOption> | StdioOption;
@@ -77,6 +81,6 @@ declare class SHDispatch {
     * @returns {SpawnSyncResponse}
     */
     runSync(payload?: string | undefined): SpawnSyncResponse;
-    kill(): Promise<void>;
+    kill(signal?: string): Promise<number[]>;
     #private;
 }

package/types/SHExecute.d.ts

@@ -16,6 +16,8 @@ declare class SHExecute {
     */
     run(payload?: string | undefined): Promise<any>;
     /**
+    * Kill this process and possible child processes
+    * @param {string} signal - kill signal
     * @returns {Promise<number[]>}
     */
     kill(signal?: string): Promise<number[]>;