1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify stdout/stderr arguments to callback

Browse Source 
Clarify that the arguments to child_process.execFile
and child_process.exec callback can be Buffer or strings.

Fixes: https://github.com/nodejs/node/issues/3389
PR-URL: https://github.com/nodejs/node/pull/6015
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This commit is contained in:
James M Snell 2016-04-01 22:23:16 -07:00
parent ba0b769c7b
commit 6fd26dcc20
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/api/child_process.markdown
View File

@ -131,8 +131,8 @@ exec('my.bat', (err, stdout, stderr) => {
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates * `callback` {Function} called with the output when process terminates
* `error` {Error} * `error` {Error}
* `stdout` {Buffer} * `stdout` {String|Buffer}
* `stderr` {Buffer} * `stderr` {String|Buffer}
* Return: {ChildProcess} * Return: {ChildProcess}
Spawns a shell then executes the `command` within that shell, buffering any Spawns a shell then executes the `command` within that shell, buffering any
@ -157,6 +157,13 @@ the exit code of the child process while `error.signal` will be set to the
signal that terminated the process. Any exit code other than `0` is considered signal that terminated the process. Any exit code other than `0` is considered
to be an error. to be an error.
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
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
stderr output. If `encoding` is `'buffer'`, `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:
@ -198,8 +205,8 @@ replace the existing process and uses a shell to execute the command.*
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates * `callback` {Function} called with the output when process terminates
* `error` {Error} * `error` {Error}
* `stdout` {Buffer} * `stdout` {String|Buffer}
* `stderr` {Buffer} * `stderr` {String|Buffer}
* Return: {ChildProcess} * Return: {ChildProcess}
The `child_process.execFile()` function is similar to [`child_process.exec()`][] The `child_process.execFile()` function is similar to [`child_process.exec()`][]
@ -220,6 +227,13 @@ const child = execFile('node', ['--version'], (error, stdout, stderr) => {
}); });
``` ```
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
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
stderr output. If `encoding` is `'buffer'`, `Buffer` objects will be passed to
the callback instead.
### child_process.fork(modulePath[, args][, options]) ### child_process.fork(modulePath[, args][, options])
* `modulePath` {String} The module to run in the child * `modulePath` {String} The module to run in the child