JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14945625
  • Score
    100M100P100Q213691F
  • License MIT

Cross platform children list of a PID

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

Mac/Linux Build Status Windows Build status Codecov Coverage report Known Vulnerabilities Dependency Status
XO Code Style used AVA Test Runner used Istanbul Test Coverage used NI Scaffolding System used NP Release System used
Latest version on npm Project license

🚸 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, pids) {
  console.log(pids)
  // => []
})

// Include the given pid in the result array
pidtree(process.pid, {root: true}, function (err, pids) {
  console.log(pids)
  // => [727]
})

// Get all the processes of the System on *nix
pidtree(1, function (err, pids) {
  console.log(pids)
  // => [41,45,43,530,47,50, ..., 41241, 32]
})

// If no callback is given it returns a promise instead
const pids = await pidtree(1)
console.log(pids)
// => [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 similarly to pgrep -P on *unix

npx pidtree $PPID

Just replace $PPID with one of the pids inside your system.

Or don't pass anything if you want all the pids inside your system.

npx pidtree

API

pidtree(pid, [options], [callback]) ⇒ Promise.<Object>

Get the list of child pids of the given pid.

Kind: global function
Returns: Promise.<Object> - Only when the callback is not provided.
Access: public

Param Type Default Description
pid Number | String A pid.
[options] Object Optional options object.
[options.root] Boolean false Include the provided pid in the list.
[callback] function Called when the list is ready. If not provided a promise is returned instead.
  • pidusage - Cross-platform process cpu % and memory usage of a PID

Authors

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.