Skip to content

Commit 8eeccd8

Browse files
thefourtheyeMylesBorins
authored andcommitted
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 7db7e47 commit 8eeccd8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/api/child_process.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ added: v0.1.90
129129
* `timeout` {Number} (Default: 0)
130130
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
131131
stderr - if exceeded child process is killed (Default: `200*1024`)
132-
* `killSignal` {String} (Default: 'SIGTERM')
132+
* `killSignal` {String|Integer} (Default: 'SIGTERM')
133133
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
134134
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
135135
* `callback` {Function} called with the output when process terminates
@@ -210,7 +210,7 @@ added: v0.1.91
210210
* `timeout` {Number} (Default: 0)
211211
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
212212
stderr - if exceeded child process is killed (Default: 200\*1024)
213-
* `killSignal` {String} (Default: 'SIGTERM')
213+
* `killSignal` {String|Integer} (Default: 'SIGTERM')
214214
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
215215
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
216216
* `callback` {Function} called with the output when process terminates
@@ -571,7 +571,7 @@ added: v0.11.12
571571
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
572572
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
573573
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
574-
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
574+
* `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
575575
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
576576
stderr - if exceeded child process is killed
577577
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
@@ -610,7 +610,7 @@ added: v0.11.12
610610
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
611611
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
612612
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
613-
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
613+
* `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
614614
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
615615
stderr - if exceeded child process is killed
616616
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
@@ -648,7 +648,7 @@ added: v0.11.12
648648
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
649649
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
650650
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
651-
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
651+
* `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
652652
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
653653
stderr - if exceeded child process is killed
654654
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')

0 commit comments

Comments
 (0)