child_process: document kill() return value

This commit documents the return value from subprocess.kill(). PR-URL: #30669 Refs: #30668 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Dec 5, 2019 · a2ef669 · a2ef669
1 parent e2f8d23
commit a2ef669
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/api/child_process.md b/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');