package
A library of utilities for dealing with system processes.
npm install tinypsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
A cross-platform library of utilities for dealing with system processes.
npm install tinypsimport { killTree, getProcessTree, getProcessAncestry } from 'tinyps';
// kill a process and everything it spawned
await killTree(child.pid);
// or inspect the tree first
const tree = await getProcessTree(child.pid);
console.log(tree.get(child.pid)); // [ 1234, 1235 ]
// trace a process's parent chain back to the root
const ancestry = await getProcessAncestry(child.pid);
console.log(ancestry.map((proc) => proc.pid)); // [ childPid, parentPid, ... ]killTree(pid, signal?)pid (number) - process to kill, along with all of its descendantssignal (NodeJS.Signals, optional) - signal to send, defaults to SIGTERMPromise<void>Note that signal is not supported on Windows, and will be ignored.
getProcessTree(pid)pid (number) - process to build the tree fromPromise<ProcessTree>isRunning(pid)pid (number) - process to checkbooleanA zombie process is still in the process table, so this returns true for a
process which has exited but has not yet been released by its parent.
getDescendants(pid)pid (number) - process to collect descendants ofPromise<number[]>getProcessAncestry(pid?)pid (number, optional) - process to trace ancestry from, defaults to process.pidPromise<ProcessInfo[]>Returns an ordered list of process info objects starting from the target process and traversing upward through its parents to the root process.
Note: On Windows, a parent may have exited and had its pid reassigned. In that case, the ancestry may contain unrelated processes.
listProcesses()Promise<ProcessInfo[]>getProcessInfo(pid)pid (number) - process to look upPromise<ProcessInfo | undefined>findProcessesByName(name, options?)name (string) - name to match againstoptions.loose (boolean, optional) - match any name containing name, ignoring casePromise<ProcessInfo[]>Names come from the process' argv[0], so a process which has renamed itself
(e.g. via process.title) matches its new name rather than its executable.
findProcessesByPort(port, options?)port (number) - local port to match againstoptions.protocol ('tcp' | 'udp', optional) - only match sockets of this
protocol, defaults to matching bothPromise<ProcessInfo[]>Matches any process holding a socket bound to port locally, whether it is
listening or connected.
MIT
Estimated unpacked size across 1 packages.
16.6 kB
Includes dependencies.