Commit 8314d9e
doc: killSignal option accepts integer values
`killSignal` option accepts the signal name or signal number as well.
PR-URL: #10424
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>1 parent 736a7f3 commit 8314d9e
1 file changed
Lines changed: 8 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -137,7 +137,7 @@ added: v0.1.90 | |||
| 137 | 137 | * `timeout` {Number} (Default: `0`) | |
| 138 | 138 | * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on | |
| 139 | 139 | stdout or stderr - if exceeded child process is killed (Default: `200*1024`) | |
| 140 | - * `killSignal` {String} (Default: `'SIGTERM'`) | ||
| 140 | + * `killSignal` {String|Integer} (Default: `'SIGTERM'`) | ||
| 141 | 141 | * `uid` {Number} Sets the user identity of the process. (See setuid(2).) | |
| 142 | 142 | * `gid` {Number} Sets the group identity of the process. (See setgid(2).) | |
| 143 | 143 | * `callback` {Function} called with the output when process terminates | |
@@ -214,7 +214,7 @@ added: v0.1.91 | |||
| 214 | 214 | * `timeout` {Number} (Default: `0`) | |
| 215 | 215 | * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on | |
| 216 | 216 | stdout or stderr - if exceeded child process is killed (Default: `200*1024`) | |
| 217 | - * `killSignal` {String} (Default: `'SIGTERM'`) | ||
| 217 | + * `killSignal` {String|Integer} (Default: `'SIGTERM'`) | ||
| 218 | 218 | * `uid` {Number} Sets the user identity of the process. (See setuid(2).) | |
| 219 | 219 | * `gid` {Number} Sets the group identity of the process. (See setgid(2).) | |
| 220 | 220 | * `callback` {Function} called with the output when process terminates | |
@@ -591,8 +591,8 @@ added: v0.11.12 | |||
| 591 | 591 | * `gid` {Number} Sets the group identity of the process. (See setgid(2).) | |
| 592 | 592 | * `timeout` {Number} In milliseconds the maximum amount of time the process | |
| 593 | 593 | is allowed to run. (Default: `undefined`) | |
| 594 | - * `killSignal` {String} The signal value to be used when the spawned process | ||
| 595 | - will be killed. (Default: `'SIGTERM'`) | ||
| 594 | + * `killSignal` {String|Integer} The signal value to be used when the spawned | ||
| 595 | + process will be killed. (Default: `'SIGTERM'`) | ||
| 596 | 596 | * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on | |
| 597 | 597 | stdout or stderr - if exceeded child process is killed | |
| 598 | 598 | * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`) | |
@@ -633,8 +633,8 @@ added: v0.11.12 | |||
| 633 | 633 | * `gid` {Number} Sets the group identity of the process. (See setgid(2).) | |
| 634 | 634 | * `timeout` {Number} In milliseconds the maximum amount of time the process | |
| 635 | 635 | is allowed to run. (Default: `undefined`) | |
| 636 | - * `killSignal` {String} The signal value to be used when the spawned process | ||
| 637 | - will be killed. (Default: `'SIGTERM'`) | ||
| 636 | + * `killSignal` {String|Integer} The signal value to be used when the spawned | ||
| 637 | + process will be killed. (Default: `'SIGTERM'`) | ||
| 638 | 638 | * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on | |
| 639 | 639 | stdout or stderr - if exceeded child process is killed | |
| 640 | 640 | * `encoding` {String} The encoding used for all stdio inputs and outputs. | |
@@ -675,8 +675,8 @@ added: v0.11.12 | |||
| 675 | 675 | * `gid` {Number} Sets the group identity of the process. (See setgid(2).) | |
| 676 | 676 | * `timeout` {Number} In milliseconds the maximum amount of time the process | |
| 677 | 677 | is allowed to run. (Default: `undefined`) | |
| 678 | - * `killSignal` {String} The signal value to be used when the spawned process | ||
| 679 | - will be killed. (Default: `'SIGTERM'`) | ||
| 678 | + * `killSignal` {String|Integer} The signal value to be used when the spawned | ||
| 679 | + process will be killed. (Default: `'SIGTERM'`) | ||
| 680 | 680 | * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on | |
| 681 | 681 | stdout or stderr - if exceeded child process is killed | |
| 682 | 682 | * `encoding` {String} The encoding used for all stdio inputs and outputs. | |
0 commit comments