Skip to content
This repository was archived by the owner on Apr 22, 2023. It is now read-only.

Commit b0cd038

Browse files
committed
docs: be specific about the unit of maxBuffer
It's nice to be specific about units in docs.
1 parent cfcb1de commit b0cd038

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/api/child_process.markdown

+6-6
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ See also: `child_process.exec()` and `child_process.fork()`
485485
understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
486486
command line parsing should be compatible with `cmd.exe`.)
487487
* `timeout` {Number} (Default: 0)
488-
* `maxBuffer` {Number} (Default: `200*1024`)
488+
* `maxBuffer` {Number} Max bytes (Default: `200*1024`)
489489
* `killSignal` {String} (Default: 'SIGTERM')
490490
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
491491
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
@@ -527,7 +527,7 @@ default options are
527527
If `timeout` is greater than 0, then it will kill the child process
528528
if it runs longer than `timeout` milliseconds. The child process is killed with
529529
`killSignal` (default: `'SIGTERM'`). `maxBuffer` specifies the largest
530-
amount of data allowed on stdout or stderr - if this value is exceeded then
530+
amount of data (in bytes) allowed on stdout or stderr - if this value is exceeded then
531531
the child process is killed.
532532

533533

@@ -540,7 +540,7 @@ the child process is killed.
540540
* `env` {Object} Environment key-value pairs
541541
* `encoding` {String} (Default: 'utf8')
542542
* `timeout` {Number} (Default: 0)
543-
* `maxBuffer` {Number} (Default: 200\*1024)
543+
* `maxBuffer` {Number} Max bytes (Default: 200\*1024)
544544
* `killSignal` {String} (Default: 'SIGTERM')
545545
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
546546
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
@@ -612,7 +612,7 @@ configuration at startup.
612612
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
613613
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
614614
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
615-
* `maxBuffer` {Number}
615+
* `maxBuffer` {Number} Max bytes
616616
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
617617
* return: {Object}
618618
* `pid` {Number} Pid of the child process
@@ -645,7 +645,7 @@ process has exited.
645645
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
646646
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
647647
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
648-
* `maxBuffer` {Number}
648+
* `maxBuffer` {Number} Max bytes
649649
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
650650
* return: {Buffer|String} The stdout from the command
651651

@@ -675,7 +675,7 @@ throw. The `Error` object will contain the entire result from
675675
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
676676
* `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
677677
* `killSignal` {String} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
678-
* `maxBuffer` {Number}
678+
* `maxBuffer` {Number} Max bytes
679679
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
680680
* return: {Buffer|String} The stdout from the command
681681

0 commit comments

Comments
 (0)