Install

npm i process-list
# or
yarn add process-list

It's that easy! npm will download one of the prebuilt binaries for your OS. If you need to build process-list, see node-gyp for more details.

Supported OS

• Windows Windows 7+, Windows Server 2008 R2+
• Linux any Linux-based distributives
• OS X Soon...

Usage

const { snapshot } = require("process-list");

const tasks = await snapshot('pid', 'name');
console.log(tasks);

// output
// [{
//    name: "1.exe",
//    pid: 1234,
// }, ... ]

API

snapshot(...field: String): Promise<[]Object>

Returns the list of the launched processes.

allowedFields: []String

List of allowed fields.

• pid: Number - process pid
• ppid: Number - parent process pid
• name: String - process name (title)
• path: String - full path to the process binary file
• threads: Number - threads per process
• owner: String - the owner of the process (very time intensive on windows depending on elevation, can take 20 seconds or more)
• priority: Number - an os-specific process priority
• cmdline: String - full command line of the process
• starttime: Date - the process start date / time (time intensive on windows, can take 200-400ms depending on the system)
• vmem: String - virtual memory size in bytes used by process
• pmem: String - physical memory size in bytes used by process
• cpu: Number - cpu usage by process in percent (time intensive on windows, can take 200-400ms depending on the system)
• utime: String - amount of time in ms that this process has been scheduled in user mode
• stime: String - amount of time that in ms this process has been scheduled in kernel mode

License

MIT, Copyright © 2014 - 2019 Dmitry Tsvettsikh