@@ -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).)
@@ -618,8 +620,9 @@ changes:
618
620
is allowed to run. (Default: ` undefined ` )
619
621
* ` killSignal ` {string|integer} The signal value to be used when the spawned
620
622
process will be killed. (Default: ` 'SIGTERM' ` )
621
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
622
- stdout or stderr - if exceeded child process is killed
623
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
624
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
625
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
623
626
* ` encoding ` {string} The encoding used for all stdio inputs and outputs. (Default: ` 'buffer' ` )
624
627
* Returns: {Buffer|string} The stdout from the command
625
628
@@ -664,8 +667,9 @@ changes:
664
667
is allowed to run. (Default: ` undefined ` )
665
668
* ` killSignal ` {string|integer} The signal value to be used when the spawned
666
669
process will be killed. (Default: ` 'SIGTERM' ` )
667
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
668
- stdout or stderr - if exceeded child process is killed
670
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
671
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
672
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
669
673
* ` encoding ` {string} The encoding used for all stdio inputs and outputs.
670
674
(Default: ` 'buffer' ` )
671
675
* Returns: {Buffer|string} The stdout from the command
@@ -716,8 +720,9 @@ changes:
716
720
is allowed to run. (Default: ` undefined ` )
717
721
* ` killSignal ` {string|integer} The signal value to be used when the spawned
718
722
process will be killed. (Default: ` 'SIGTERM' ` )
719
- * [ ` maxBuffer ` ] [ ] {number} largest amount of data (in bytes) allowed on
720
- stdout or stderr - if exceeded child process is killed
723
+ * ` maxBuffer ` {number} Largest amount of data in bytes allowed on stdout or
724
+ stderr. (Default: ` 200*1024 ` ) If exceeded, the child process is terminated.
725
+ See caveat at [ ` maxBuffer ` and Unicode] [ ] .
721
726
* ` encoding ` {string} The encoding used for all stdio inputs and outputs.
722
727
(Default: ` 'buffer' ` )
723
728
* ` shell ` {boolean|string} If ` true ` , runs ` command ` inside of a shell. Uses
@@ -1235,7 +1240,7 @@ to `stdout` although there are only 4 characters.
1235
1240
[ `Error` ] : errors.html#errors_class_error
1236
1241
[ `EventEmitter` ] : events.html#events_class_eventemitter
1237
1242
[ `JSON.stringify()` ] : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
1238
- [ `maxBuffer` ] : #child_process_maxbuffer_and_unicode
1243
+ [ `maxBuffer` and Unicode ] : #child_process_maxbuffer_and_unicode
1239
1244
[ `net.Server` ] : net.html#net_class_net_server
1240
1245
[ `net.Socket` ] : net.html#net_class_net_socket
1241
1246
[ `options.detached` ] : #child_process_options_detached
0 commit comments