@@ -135,8 +135,9 @@ added: v0.1.90
135
135
understand the ` -c ` switch on UNIX or ` /d /s /c ` on Windows. On Windows,
136
136
command line parsing should be compatible with ` cmd.exe ` .)
137
137
* ` timeout ` {number} (Default: ` 0 ` )
138
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
139
- stdout or stderr - if exceeded child process is killed (Default: ` 200*1024 ` )
138
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
139
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
140
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
140
141
* ` killSignal ` {string|integer} (Default: ` 'SIGTERM' ` )
141
142
* ` uid ` {number} Sets the user identity of the process. (See setuid(2).)
142
143
* ` gid ` {number} Sets the group identity of the process. (See setgid(2).)
@@ -212,8 +213,9 @@ added: v0.1.91
212
213
* ` env ` {Object} Environment key-value pairs
213
214
* ` encoding ` {string} (Default: ` 'utf8' ` )
214
215
* ` timeout ` {number} (Default: ` 0 ` )
215
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
216
- stdout or stderr - if exceeded child process is killed (Default: ` 200*1024 ` )
216
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
217
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
218
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
217
219
* ` killSignal ` {string|integer} (Default: ` 'SIGTERM' ` )
218
220
* ` uid ` {number} Sets the user identity of the process. (See setuid(2).)
219
221
* ` gid ` {number} Sets the group identity of the process. (See setgid(2).)
@@ -612,8 +614,9 @@ changes:
612
614
is allowed to run. (Default: ` undefined ` )
613
615
* ` killSignal ` {string|integer} The signal value to be used when the spawned
614
616
process will be killed. (Default: ` 'SIGTERM' ` )
615
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
616
- stdout or stderr - if exceeded child process is killed
617
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
618
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
619
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
617
620
* ` encoding ` {string} The encoding used for all stdio inputs and outputs. (Default: ` 'buffer' ` )
618
621
* Returns: {Buffer|string} The stdout from the command
619
622
@@ -654,8 +657,9 @@ added: v0.11.12
654
657
is allowed to run. (Default: ` undefined ` )
655
658
* ` killSignal ` {string|integer} The signal value to be used when the spawned
656
659
process will be killed. (Default: ` 'SIGTERM' ` )
657
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
658
- stdout or stderr - if exceeded child process is killed
660
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
661
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
662
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
659
663
* ` encoding ` {string} The encoding used for all stdio inputs and outputs.
660
664
(Default: ` 'buffer' ` )
661
665
* Returns: {Buffer|string} The stdout from the command
@@ -703,8 +707,9 @@ changes:
703
707
is allowed to run. (Default: ` undefined ` )
704
708
* ` killSignal ` {string|integer} The signal value to be used when the spawned
705
709
process will be killed. (Default: ` 'SIGTERM' ` )
706
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
707
- stdout or stderr - if exceeded child process is killed
710
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
711
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
712
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
708
713
* ` encoding ` {string} The encoding used for all stdio inputs and outputs.
709
714
(Default: ` 'buffer' ` )
710
715
* ` shell ` {boolean|string} If ` true ` , runs ` command ` inside of a shell. Uses
@@ -1222,7 +1227,7 @@ to `stdout` although there are only 4 characters.
1222
1227
[ `Error` ] : errors.html#errors_class_error
1223
1228
[ `EventEmitter` ] : events.html#events_class_eventemitter
1224
1229
[ `JSON.stringify()` ] : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
1225
- [ `maxBuffer` ] : #child_process_maxbuffer_and_unicode
1230
+ [ `maxBuffer` and Unicode ] : #child_process_maxbuffer_and_unicode
1226
1231
[ `net.Server` ] : net.html#net_class_net_server
1227
1232
[ `net.Socket` ] : net.html#net_class_net_socket
1228
1233
[ `options.detached` ] : #child_process_options_detached
0 commit comments