0.6.0 • Published 2 years ago

pidtree v0.6.0

Weekly downloads
2,053,665
License
MIT
Repository
github
Last release
2 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-tableeasyplayer-myeirenewatchelectron-process-reporterdredd-hooks-templatereact-lightbox-pack-18supportexpo-renavigatefixed_form_builderhong1-utilsreact-tailwindcss-datepicker-costume-2fakebrowserfakebrowser-devfastify-flux-cligogencygogency-test-2react-rect-progressbarrun-screenrun-shared-scripts@webundsoehne/nx-tools@blazinaj/app-kit@arcblock/forge-cli@bubkoo/husky-hooks@devjoyvn/fakebrowser@vercel/remix-run-deviobroker.terminalresponsis-gantt-task-react@visma-digital-commerce/pwa-klarna@comet/dev-process-manager@dogu-tech/node@coralproject/npm-run-alllint-staged-mrsympact@amiruldev/wajs@cybermega/flutter-resource-manager-rscanary-farm-lint-staged@fluxapi/clisaasifytldrawlignin@meodemsao/fakebrowser@jsenv/testturbowatch@mikegpl/hyperflow-job-executorundetectableneural_compressor_ext_lab_customizedneural_compressor_ext_lab_customized_2@mcsb/watchnew-run-all@hzamir/npm-run-allclazz-transformer@faizanhaider/iconsaxmonex@hyperflow/job-executornanoprocess@magne4000/electron-process-reporter@object-studio/react-native-webweb-elements-icons@push.rocks/smartmetrics@pushrocks/smartmetrics@secretflow/husky-hookspackage-example.jsonp147-tablep148-tablenka-gantt-task-react@kommunicate/kommunicate-chatbot-pluginnjs-wa-autonotiosnomakedesign-system-fitbank-450npm-run-all2@open-wa/wa-automate@erda-ui/clicdktf-cli@hieuquang2212/form@enirisdev/angular-google-chartsterminate-children@hdkhoa1302/app-themes@leiyulf/gantt-task-reactcreate-saas-app@krisdages/electron-process-reporternode-red-contrib-process-resourcespidusage-treewinx-form-winx@remix-run/dev@perdieminc/models@safely-project/safely-tsvue-picocss@plasmo-corp/rps@plasmohq/rpsopea-bootstrapwa-frikzyggdev@ribarich/lint-staged@sung/subsequence@skedulr/nebula-ui-librarycustompackagetestvarthini
0.6.0

2 years ago

0.5.0

4 years ago

0.4.0

4 years ago

0.3.1

4 years ago

0.3.0

6 years ago

0.2.0

6 years ago

0.1.4

6 years ago

0.1.3

6 years ago

0.1.2

6 years ago

0.1.1

6 years ago