pidtree
Advanced tools
Package description
The pidtree npm package is a Node.js module that allows you to list all running processes in a hierarchical tree structure based on their process IDs (PIDs). It can be used to find parent and child processes of a given PID, which is useful for monitoring and managing system processes programmatically.
Get an array of all running processes as a tree
This code sample demonstrates how to retrieve a tree of all running processes. The '-1' argument specifies that the tree should start with the root process. The callback function receives the tree structure or an error.
const pidtree = require('pidtree');
pidtree(-1, function (err, tree) {
if (err) throw err;
console.log(tree);
});Get a tree of child processes for a specific PID
This code sample shows how to get a tree of child processes for a specific PID. Replace '1234' with the PID of the process you want to inspect. The callback function will receive the tree of child processes or an error.
const pidtree = require('pidtree');
const pid = 1234; // Replace with the target PID
pidtree(pid, function (err, tree) {
if (err) throw err;
console.log(tree);
});The ps-tree package is similar to pidtree in that it also provides a way to list child processes of a given PID. However, ps-tree does not create a hierarchical tree structure but instead returns a flat list of child processes.
While tree-kill does not provide a way to list processes, it offers related functionality by allowing users to kill all processes in the tree of a given PID. This is useful for cleaning up child processes when the parent process is terminated.
Readme
🚸 Cross platform children list of a PID.
Coded with ❤️ by Simone Primarosa.
The only package that does this simple but tricky job is ps-tree but the project is unmaintained and furthermore the logic is wrong.
var pidtree = require('pidtree')
// Get childs of current process
pidtree(process.pid, function (err, stat) {
console.log(stat)
// => []
})
// Include the given pid in the result array
pidtree(process.pid, {root: true}, function (err, stat) {
console.log(stat)
// => [727]
})
// Get all the processes of the System on *nix
pidtree(1, function (err, stat) {
console.log(stat)
// => [41,45,43,530,47,50, ..., 41241, 32]
})
| Linux | FreeBSD | NetBSD | SunOS | macOS | Win | AIX |
|---|---|---|---|---|---|---|
| ✅ | ❓ | ❓ | ❓ | ✅ | ✅ | ❓ |
✅ = Working ❓ = Not tested but should work
Please if your platform is not supported file an issue.
Get pid informations.
Kind: global function
Access: public
| Param | Type | Default | Description |
|---|---|---|---|
| pids | Number | String | A pid. | |
| options | Object | Optional options object. | |
| options.root | Boolean | false | Include the provided pid in the list. |
| callback | pidCallback | Called when the list is ready. |
functionKind: global typedef
| Param | Type | Description |
|---|---|---|
| err | Error | A possible error. |
| statistics | Array. | The array containing the child pids. |
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the license file for details.
FAQs
Cross platform children list of a PID
The npm package pidtree receives a total of 7,472,632 weekly downloads. As such, pidtree popularity was classified as popular.
We found that pidtree demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.