Skip to content
Permalink
Browse files

child_process: document kill() return value

This commit documents the return value from subprocess.kill().

PR-URL: #30669
Refs: #30668
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
cjihrig authored and MylesBorins committed Nov 26, 2019
1 parent 6b380cc commit f9f3ab293f00207cb87ce3f28b342dd61377b919
Showing with 3 additions and 1 deletion.
  1. +3 −1 doc/api/child_process.md
@@ -1044,10 +1044,12 @@ added: v0.1.90
-->

* `signal` {number|string}
* Returns: {boolean}

The `subprocess.kill()` method sends a signal to the child process. If no
argument is given, the process will be sent the `'SIGTERM'` signal. See
signal(7) for a list of available signals.
signal(7) for a list of available signals. This function returns `true` if
kill(2) succeeds, and `false` otherwise.

```js
const { spawn } = require('child_process');

0 comments on commit f9f3ab2

Please sign in to comment.
You can’t perform that action at this time.