doc: edit maxBuffer/Unicode paragraph for clarity

Remove unneeded words from child_process doc.

PR-URL: https://github.com/nodejs/node/pull/11228
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
pull/7986/head
Rich Trott 2017-02-07 13:08:52 -08:00
parent 59afa275ad
commit a3bc9a1991
1 changed files with 5 additions and 10 deletions

View File

@ -1157,16 +1157,11 @@ to the same value.
## `maxBuffer` and Unicode
It is important to keep in mind that the `maxBuffer` option specifies the
largest number of *octets* allowed on `stdout` or `stderr`. If this value is
exceeded, then the child process is terminated. This particularly impacts
output that includes multibyte character encodings such as UTF-8 or UTF-16.
For instance, the following will output 13 UTF-8 encoded octets to `stdout`
although there are only 4 characters:
```js
console.log('中文测试');
```
The `maxBuffer` option specifies the largest number of bytes allowed on `stdout`
or `stderr`. If this value is exceeded, then the child process is terminated.
This impacts output that includes multibyte character encodings such as UTF-8 or
UTF-16. For instance, `console.log('中文测试')` will send 13 UTF-8 encoded bytes
to `stdout` although there are only 4 characters.
[`'error'`]: #child_process_event_error
[`'exit'`]: #child_process_event_exit