Skip to content

Commit e04b053

Browse files
thw0rtedrvagg
authored andcommitted
doc: document 'inherit' option for stdio (non-shorthand)
PR-URL: #22309 Fixes: #22297 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 8d226c6 commit e04b053

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

doc/api/child_process.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -590,8 +590,7 @@ For convenience, `options.stdio` may be one of the following strings:
590590

591591
* `'pipe'` - equivalent to `['pipe', 'pipe', 'pipe']` (the default)
592592
* `'ignore'` - equivalent to `['ignore', 'ignore', 'ignore']`
593-
* `'inherit'` - equivalent to `[process.stdin, process.stdout, process.stderr]`
594-
or `[0,1,2]`
593+
* `'inherit'` - equivalent to `['inherit', 'inherit', 'inherit']` or `[0, 1, 2]`
595594

596595
Otherwise, the value of `options.stdio` is an array where each index corresponds
597596
to an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,
@@ -617,16 +616,20 @@ pipes between the parent and child. The value is one of the following:
617616
will always open fds 0 - 2 for the processes it spawns, setting the fd to
618617
`'ignore'` will cause Node.js to open `/dev/null` and attach it to the
619618
child's fd.
620-
4. {Stream} object - Share a readable or writable stream that refers to a tty,
619+
4. `'inherit'` - Pass through the corresponding stdio stream to/from the
620+
parent process. In the first three positions, this is equivalent to
621+
`process.stdin`, `process.stdout`, and `process.stderr`, respectively. In
622+
any other position, equivalent to `'ignore'`.
623+
5. {Stream} object - Share a readable or writable stream that refers to a tty,
621624
file, socket, or a pipe with the child process. The stream's underlying
622625
file descriptor is duplicated in the child process to the fd that
623626
corresponds to the index in the `stdio` array. Note that the stream must
624627
have an underlying descriptor (file streams do not until the `'open'`
625628
event has occurred).
626-
5. Positive integer - The integer value is interpreted as a file descriptor
629+
6. Positive integer - The integer value is interpreted as a file descriptor
627630
that is currently open in the parent process. It is shared with the child
628631
process, similar to how {Stream} objects can be shared.
629-
6. `null`, `undefined` - Use default value. For stdio fds 0, 1, and 2 (in other
632+
7. `null`, `undefined` - Use default value. For stdio fds 0, 1, and 2 (in other
630633
words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
631634
default is `'ignore'`.
632635

0 commit comments

Comments
 (0)