tasklist-sync v1.0.0

tasklist-sync

Fork from https://github.com/sindresorhus/tasklist/tree/v4.0.1

Install

$ npm install tasklist-sync

Usage

const tasklist = require('tasklist-sync')
console.log(tasklist())
/*
[{
    imageName: 'taskhostex.exe',
    pid: 1820,
    sessionName: 'Console',
    sessionNumber: 1,
    memUsage: 4415488
}, …]
*/

API

See the tasklist docs for more.

tasklist(options?)

Returns a Array with running tasks.

options

Type: object

The system, username, password options must be specified together.

verbose

Type: boolean Default: false

Return verbose results.

Without the verbose option, taskkill returns tasks with the following properties:

• imageName (Type: string)
• pid (Type: number)
• sessionName (Type: string)
• sessionNumber (Type: number)
• memUsage in bytes (Type: number)

With the verbose option set to true, it additionally returns the following properties:

• status (Type: string): One of Running, Suspended, Not Responding, or Unknown
• username (Type: string)
• cpuTime in seconds (Type: number)
• windowTitle (Type: string)

Note: It's not guaranteed that the username and windowTitle properties are returned with proper values. If they are not available, 'N/A' may be returned on English systems. In contrast, 'Nicht zutreffend' may be returned on German systems, for example.

Verbose example:

const tasklist = require('tasklist')
console.log(tasklist({verbose: true}))
/*
[{
    imageName: 'taskhostex.exe',
    pid: 1820,
    sessionName: 'Console',
    sessionNumber: 1,
    memUsage: 4415488,
    status: 'Running',
    username: 'SINDRESORHU3930\\sindre'
    cpuTime: 0,
    windowTitle: 'Task Host Window'
}, …]
*/

Warning: Using the verbose option may have a considerable performance impact (See: #6).

system

Type: string

Name or IP address of a remote computer (don't use backslashes). The default is the local computer.

username

Type: string Example: SINDRESORHU3930\\sindre

User specified by User or Domain\User. The default is the permissions of the current logged on user on the computer issuing the command.

password

Type: string

Password of the user account for the specified username.

filter

Type: array

Specify the types of processes to include or exclude. More info.