0.6.0 • Published 3 years ago

pidtree v0.6.0

Weekly downloads
2,053,665
License
MIT
Repository
github
Last release
3 years ago

Synopsis

This package is really similar to ps-tree but is faster, safer and provides sub-children results.
Furthermore ps-tree is unmaintained.

Uuh, and a fancy CLI is also available!

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 (-1 is a special value of this package)
pidtree(-1, function (err, pids) {
  console.log(pids)
  // => [530, 42, ..., 41241]
})

// Include PPID in the results
pidtree(1, {advanced: true}, function (err, pids) {
  console.log(pids)
  // => [{ppid: 1, pid: 530}, {ppid: 1, pid: 42}, ..., {ppid: 1, pid: 41241}]
})

// If no callback is given it returns a promise instead
const pids = await pidtree(1)
console.log(pids)
// => [141, 42, ..., 15242]

Compatibility

LinuxFreeBSDNetBSDSunOSmacOSWinAIX

✅ = Working ❓ = Not tested but should work

Please if your platform is not supported file an issue.

CLI

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

To display the output as a list, similar to the one produced from pgrep -P $PID, pass the --list flag.

npx pidtree --list

API

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

Get the list of children pids of the given pid.

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

ParamTypeDefaultDescription
pidNumber | StringA pid. If -1 will return all the pids.
optionsObjectOptional options object.
options.rootBooleanfalseInclude the provided pid in the list. Ignored if -1 is passed as pid.
callbackfunctionCalled when the list is ready. If not provided a promise is returned instead.

Related

  • 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.

lint-stagednpm-run-all@infinitebrahmanuniverse/nolb-pidopea-bootstraap@everything-registry/sub-chunk-2435p149-tablesympactwinx-form-winxweb-elements-iconswa-automatev9u-smb2-singstor@dogu-tech/node@cristianps1988/ds-template@comet/dev-process-manager@cybermega/flutter-resource-manager-rs@coralproject/npm-run-all@pradeepgudipati/kovaad-chat-ui-kit-stylescauseway-concrete-styleswa-frikzterminate-childrentldrawligninturbowatchvue-picocss@amiruldev/wajs@arcblock/forge-cli@blazinaj/app-kit@bubkoo/husky-hooks@codingdud/coolicons@devjoyvn/fakebrowser@dario-hacking/remix-run-devyggdevyardmanyangtao-jsundetectable@hdkhoa1302/app-themes@fluxapi/cli@getstation/electron-process-reporter@krenaldi/learnstorybook-design-system-template@krisdages/electron-process-reporter@leiyulf/gantt-task-react@magne4000/electron-process-reporter@marsel888/job-executor@enirisdev/angular-google-charts@erda-ui/cli@faizanhaider/iconsax@mcsb/watch@mikegpl/hyperflow-job-executor@meodemsao/fakebrowser@kommunicate/kommunicate-chatbot-plugin@jsenv/test@hieuquang2212/form@hzamir/npm-run-all@hyperflow/job-executor@push.rocks/smartmetrics@safely-project/safely-ts@pushrocks/smartmetrics@qiwi/npm-run-all@ribarich/lint-staged@open-wa/wa-automate@plasmo-corp/rps@phydy/lend@pgm/shiny-instance@plasmohq/rps@object-studio/react-native-web@remix-run/dev@secretflow/husky-hooksmpd-parser-1monexmirage_toolkitnanoprocesspackage-example.jsonp147-tablep148-tablenpm-run-all2opea-bootstraprun-screenreact-lightbox-pack-18supportsaasifyrun-shared-scriptsreact-gantt-chart7node-red-contrib-process-resourcesnjs-wa-autonka-gantt-task-reactnew-run-allneural_compressor_ext_lab_customizedneural_compressor_ext_lab_customized_2nomakenotiospidusage-treeproject-wajs-dvresponsis-gantt-task-reactreact-rect-progressbarskysyncreact-tailwindcss-datepicker-costume-2gogencygogency-test-2hong1-utilsiobroker.terminallint-staged-mrmassa-web3-fork-workspace
0.6.0

3 years ago

0.5.0

5 years ago

0.4.0

5 years ago

0.3.1

5 years ago

0.3.0

7 years ago

0.2.0

7 years ago

0.1.4

7 years ago

0.1.3

7 years ago

0.1.2

7 years ago

0.1.1

7 years ago