Package Exports
- pidtree
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pidtree) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
pidtree
🚸 Cross platform children list of a PID.
Coded with ❤️ by Simone Primarosa.
Motivation
The only package that does this simple but tricky job is ps-tree but the project is unmaintained and furthermore the logic is wrong.
Usage
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]
})
Compatibility
Linux | FreeBSD | NetBSD | SunOS | macOS | Win | AIX |
---|---|---|---|---|---|---|
✅ | ❓ | ❓ | ❓ | ✅ | ✅ | ❓ |
✅ = Working ❓ = Not tested but should work
Please if your platform is not supported file an issue.
CLI
This package behave similar to pgrep
on *unix
npx pidtree $PPID
Just replace $PPID with one of the pids inside your system.
API
pidtree(pids, callback)
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. |
pidCallback : function
Kind: global typedef
Param | Type | Description |
---|---|---|
err | Error |
A possible error. |
statistics | Array.<Number> |
The array containing the child pids. |
Related
- pidusage - Cross-platform process cpu % and memory usage of a PID
Authors
- Simone Primarosa - simonepri
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the license file for details.