Commit f9f3ab2
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>1 parent 6b380cc commit f9f3ab2
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1044,10 +1044,12 @@ added: v0.1.90 | |||
| 1044 | 1044 | --> | |
| 1045 | 1045 | ||
| 1046 | 1046 | * `signal` {number|string} | |
| 1047 | + * Returns: {boolean} | ||
| 1047 | 1048 | ||
| 1048 | 1049 | The `subprocess.kill()` method sends a signal to the child process. If no | |
| 1049 | 1050 | 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. | ||
| 1051 | 1053 | ||
| 1052 | 1054 | ```js | |
| 1053 | 1055 | const { spawn } = require('child_process'); | |
0 commit comments