kill-sync
Version:
Cross-platform kill command. Supports recusive/tree-kill in a synchronous manner.
85 lines • 2.56 kB
JavaScript
/**
* Code below is inspired by tree-kill-sync and tree-kill:
* - https://github.com/dvpnt/tree-kill-sync/blob/master/index.js
* - https://github.com/pkrumins/node-tree-kill/blob/master/index.js
*/
import { execSync } from 'child_process';
/**
* Retrieves a list of all running process IDs (PIDs) along with their parent
* process IDs (PPIDs).
*
* @returns {PidItem[]} An array of PidItem objects containing PID and PPID.
*/
const getAllPids = () => execSync('ps -A -o pid=,ppid=')
.toString()
.trim()
.split('\n')
.map((row) => {
var _a;
/* istanbul ignore next */
const [, pid, ppid] = (_a = /\s*(\d+)\s*(\d+)/.exec(row)) !== null && _a !== void 0 ? _a : [];
return {
pid: Number(pid),
ppid: Number(ppid)
};
});
/**
* Retrieves all child PIDs of a given parent PID.
*
* @param {number} parentPid - The parent PID for which to find child PIDs.
* @returns {number[]} An array of child PIDs.
*/
const getAllChilds = (parentPid) => {
const all = getAllPids();
const ppidHash = all.reduce((hash, item) => {
hash[item.ppid] = (hash[item.ppid] || []).concat(item.pid);
return hash;
}, {});
const result = [];
/**
* Adds all children PIDs to the result array
*
* @param pid parent process ID of which to add children
*/
const recursivelAddChild = (pid) => {
ppidHash[pid] = ppidHash[pid] || [];
ppidHash[pid].forEach((childPid) => {
result.push(childPid);
recursivelAddChild(childPid);
});
};
recursivelAddChild(parentPid);
return result;
};
/**
* Kills a process with the specified PID using the given signal.
* The error ESRCH will be ignored.
*
* @param {number} pid - The PID of the process to be killed.
* @param {number | string} signal - The signal to send for termination.
*/
export const killPid = (pid, signal) => {
try {
process.kill(pid, signal);
}
catch (err) {
if (err.code !== 'ESRCH') {
throw err;
}
}
};
/**
* Recursively kills a process and all its child processes using the specified
* signal - i.e. terminates the whole process tree.
*
* @param {number} pid - process pid to be killed alongside children.
* @param {number | string} signal - the signal to send for termination.
*/
export const treeKill = (pid, signal) => {
const childs = getAllChilds(pid);
childs.forEach((pid) => {
killPid(pid, signal);
});
killPid(pid, signal);
};
//# sourceMappingURL=treekill.js.map