tree-kill

WebJar for tree-kill

License	MIT
GroupId	org.webjars.npm
ArtifactId	tree-kill
Last Version	1.2.2
Release Date	Apr 5, 2020
Type	jar
Description	tree-kill WebJar for tree-kill
Project URL	https://www.webjars.org
Source Code Management	https://github.com/pkrumins/node-tree-kill

Download tree-kill

Filename	Size
tree-kill-1.2.2.pom
tree-kill-1.2.2.jar	6 KB
tree-kill-1.2.2-sources.jar	22 bytes
tree-kill-1.2.2-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/tree-kill/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>tree-kill</artifactId>
    <version>1.2.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/tree-kill/
implementation 'org.webjars.npm:tree-kill:1.2.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/tree-kill/
implementation ("org.webjars.npm:tree-kill:1.2.2")

Apache Buildr

'org.webjars.npm:tree-kill:jar:1.2.2'

Apache Ivy

<dependency org="org.webjars.npm" name="tree-kill" rev="1.2.2">
  <artifact name="tree-kill" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='tree-kill', version='1.2.2')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "tree-kill" % "1.2.2"

Leiningen

[org.webjars.npm/tree-kill "1.2.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Tree Kill

Kill all processes in the process tree, including the root process.

Examples

Kill all the descendent processes of the process with pid 1, including the process with pid 1 itself:

var kill = require('tree-kill');
kill(1);

Send a signal other than SIGTERM.:

var kill = require('tree-kill');
kill(1, 'SIGKILL');

Run a callback when done killing the processes. Passes an error argument if there was an error.

var kill = require('tree-kill');
kill(1, 'SIGKILL', function(err) {
    // Do things
});

You can also install tree-kill globally and use it as a command:

tree-kill 1          # sends SIGTERM to process 1 and its descendents
tree-kill 1 SIGTERM  # same
tree-kill 1 SIGKILL  # sends KILL instead of TERMINATE

Methods

require('tree-kill')(pid, [signal], [callback]);

Sends signal signal to all children processes of the process with pid pid, including pid. Signal defaults to SIGTERM.

For Linux, this uses ps -o pid --no-headers --ppid PID to find the parent pids of PID.

For Darwin/OSX, this uses pgrep -P PID to find the parent pids of PID.

For Windows, this uses 'taskkill /pid PID /T /F' to kill the process tree. Note that on Windows, sending the different kinds of POSIX signals is not possible.

Install

With npm do:

npm install tree-kill

License

MIT

Changelog

[1.2.2] - 2019-12-11

Changed

• security fix: sanitize pid parameter to fix arbitrary code execution vulnerability

[1.2.1] - 2018-11-05

Changed

• added missing LICENSE file
• updated TypeScript definitions

[1.2.0] - 2017-09-19

Added

• TypeScript definitions

Changed

• kill(pid, callback) works. Before you had to use kill(pid, signal, callback)

[1.1.0] - 2016-05-13

Added

• A tree-kill CLI

[1.0.0] - 2015-09-17

Added

• optional callback
• Darwin support

Versions

Version
1.2.2 Apr 5, 2020