Skip to content

Commit 30a4f68

Browse files
cjihrigaddaleax
authored andcommitted
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]>
1 parent 1d1d136 commit 30a4f68

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/child_process.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1061,10 +1061,12 @@ added: v0.1.90
10611061
-->
10621062

10631063
* `signal` {number|string}
1064+
* Returns: {boolean}
10641065

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

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

0 commit comments

Comments
 (0)