Skip to content

Commit a2ef669

Browse files
cjihrigtargos
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 e2f8d23 commit a2ef669

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/child_process.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1044,10 +1044,12 @@ added: v0.1.90
10441044
-->
10451045

10461046
* `signal` {number|string}
1047+
* Returns: {boolean}
10471048

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

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

0 commit comments

Comments
 (0)