Skip to content

Commit

Permalink
doc: edit maxBuffer/Unicode paragraph for clarity
Browse files Browse the repository at this point in the history
Remove unneeded words from child_process doc.

PR-URL: #11228
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
Trott committed Feb 9, 2017
1 parent 59afa27 commit a3bc9a1
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a3bc9a1

Please sign in to comment.