Commit 30a4f68
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 1d1d136 commit 30a4f68
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1061,10 +1061,12 @@ added: v0.1.90 | |||
| 1061 | 1061 | --> | |
| 1062 | 1062 | ||
| 1063 | 1063 | * `signal` {number|string} | |
| 1064 | + * Returns: {boolean} | ||
| 1064 | 1065 | ||
| 1065 | 1066 | The `subprocess.kill()` method sends a signal to the child process. If no | |
| 1066 | 1067 | 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. | ||
| 1068 | 1070 | ||
| 1069 | 1071 | ```js | |
| 1070 | 1072 | const { spawn } = require('child_process'); | |
0 commit comments