Browse Source

doc: clarify child_process stdout/stderr types

Clarify how the encoding option interacts with the data
type of child process stdout and stderr.

Fixes: https://github.com/nodejs/node/issues/6666
PR-URL: https://github.com/nodejs/node/pull/7361
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
v4.x
sartrey 9 years ago
committed by Myles Borins
parent
commit
35ee35cba2
  1. 8
      doc/api/child_process.md

8
doc/api/child_process.md

@ -160,8 +160,8 @@ The `stdout` and `stderr` arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The `encoding` option the output as UTF-8 and pass strings to the callback. The `encoding` option
can be used to specify the character encoding used to decode the stdout and can be used to specify the character encoding used to decode the stdout and
stderr output. If `encoding` is `'buffer'`, `Buffer` objects will be passed to stderr output. If `encoding` is `'buffer'`, or an unrecognized character
the callback instead. encoding, `Buffer` objects will be passed to the callback instead.
The `options` argument may be passed as the second argument to customize how The `options` argument may be passed as the second argument to customize how
the process is spawned. The default options are: the process is spawned. The default options are:
@ -230,8 +230,8 @@ The `stdout` and `stderr` arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The `encoding` option the output as UTF-8 and pass strings to the callback. The `encoding` option
can be used to specify the character encoding used to decode the stdout and can be used to specify the character encoding used to decode the stdout and
stderr output. If `encoding` is `'buffer'`, `Buffer` objects will be passed to stderr output. If `encoding` is `'buffer'`, or an unrecognized character
the callback instead. encoding, `Buffer` objects will be passed to the callback instead.
### child_process.fork(modulePath[, args][, options]) ### child_process.fork(modulePath[, args][, options])

Loading…
Cancel
Save