diff options
| author | Tyler Anton <mtyleranton@gmail.com> | 2015-03-20 19:42:18 -0400 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2015-08-28 19:37:58 -0400 |
| commit | 2860c535625902add30f1bd10bce305db29593bb (patch) | |
| tree | eae2b79d873823192f109db8d7320b153a64a641 | |
| parent | b5a0abcfdf2e9c933c6c37c58c8205b8f94f37f6 (diff) | |
| download | node-2860c535625902add30f1bd10bce305db29593bb.tar.gz | |
doc: fixed child_process.exec doc
Changed child_process.exec documentation to reflect that the parameters stdout and stderr are instances of Buffer only if {encoding: null}. Otherwise, they are instances of String with the encoding.
Fixes #9434
removed .DS_Store
PR-URL: https://github.com/joyent/node/pull/14088
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com>
Reviewed-By: piscisaureus - Bert Belder <bertbelder@gmail.com>
| -rw-r--r-- | doc/api/child_process.markdown | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index 71b5b6d40..cb0bd2eaa 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -460,11 +460,11 @@ index corresponds to a fd in the child. The value is one of the following: ignored node will open `/dev/null` and attach it to the child's fd. 4. `Stream` object - Share a readable or writable stream that refers to a tty, file, socket, or a pipe with the child process. The stream's underlying - file descriptor is duplicated in the child process to the fd that + file descriptor is duplicated in the child process to the fd that corresponds to the index in the `stdio` array. Note that the stream must have an underlying descriptor (file streams do not until the `'open'` event has occurred). -5. Positive integer - The integer value is interpreted as a file descriptor +5. Positive integer - The integer value is interpreted as a file descriptor that is is currently open in the parent process. It is shared with the child process, similar to how `Stream` objects can be shared. 6. `null`, `undefined` - Use default value. For stdio fds 0, 1 and 2 (in other @@ -488,7 +488,7 @@ Example: ### options.detached If the `detached` option is set, the child process will be made the leader of a -new process group. This makes it possible for the child to continue running +new process group. This makes it possible for the child to continue running after the parent exits. By default, the parent will wait for the detached child to exit. To prevent @@ -544,8 +544,10 @@ See also: `child_process.exec()` and `child_process.fork()` * `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `callback` {Function} called with the output when process terminates * `error` {Error} - * `stdout` {Buffer} - * `stderr` {Buffer} + * `stdout` {Buffer} only if {encoding: null}, otherwise {String} + encoded with the specified encoding or {String} (Default: 'utf8'). + * `stderr` {Buffer} only if {encoding: null}, otherwise {String} + encoded with the specified encoding or {String} (Default: 'utf8'). * Return: ChildProcess object Runs a command in a shell and buffers the output. |