diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-11-26 13:37:31 -0500 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-11-29 11:05:49 -0500 |
| commit | 84a25eb7949a8ea887ddf8e23aa30f23a72fc5b1 (patch) | |
| tree | f92d3dd3a66cd5f707a28c208e922e862ec15275 /doc | |
| parent | 487177954201ee098ecbf5027473b238187cee22 (diff) | |
| download | android-node-v8-84a25eb7949a8ea887ddf8e23aa30f23a72fc5b1.tar.gz android-node-v8-84a25eb7949a8ea887ddf8e23aa30f23a72fc5b1.tar.bz2 android-node-v8-84a25eb7949a8ea887ddf8e23aa30f23a72fc5b1.zip | |
child_process: document kill() return value
This commit documents the return value from subprocess.kill().
PR-URL: https://github.com/nodejs/node/pull/30669
Refs: https://github.com/nodejs/node/issues/30668
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/child_process.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 7a025f94fa..746de9bd2c 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1061,10 +1061,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'); |