Skip to content

Commit 9f8bea3

Browse files
ariel-weissruyadorno
authored andcommitted
doc: fix documentation for input option in child_process
PR-URL: #49481 Fixes: #49417 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Chemi Atlow <[email protected]>
1 parent f3fea92 commit 9f8bea3

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/child_process.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -925,8 +925,8 @@ changes:
925925
* `options` {Object}
926926
* `cwd` {string|URL} Current working directory of the child process.
927927
* `input` {string|Buffer|TypedArray|DataView} The value which will be passed
928-
as stdin to the spawned process. Supplying this value will override
929-
`stdio[0]`.
928+
as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying
929+
this value will override `stdio[0]`.
930930
* `stdio` {string|Array} Child's stdio configuration. `stderr` by default will
931931
be output to the parent process' stderr unless `stdio` is specified.
932932
**Default:** `'pipe'`.
@@ -995,8 +995,8 @@ changes:
995995
* `options` {Object}
996996
* `cwd` {string|URL} Current working directory of the child process.
997997
* `input` {string|Buffer|TypedArray|DataView} The value which will be passed
998-
as stdin to the spawned process. Supplying this value will override
999-
`stdio[0]`.
998+
as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying
999+
this value will override `stdio[0]`.
10001000
* `stdio` {string|Array} Child's stdio configuration. `stderr` by default will
10011001
be output to the parent process' stderr unless `stdio` is specified.
10021002
**Default:** `'pipe'`.
@@ -1071,11 +1071,11 @@ changes:
10711071
* `options` {Object}
10721072
* `cwd` {string|URL} Current working directory of the child process.
10731073
* `input` {string|Buffer|TypedArray|DataView} The value which will be passed
1074-
as stdin to the spawned process. Supplying this value will override
1075-
`stdio[0]`.
1074+
as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying
1075+
this value will override `stdio[0]`.
10761076
* `argv0` {string} Explicitly set the value of `argv[0]` sent to the child
10771077
process. This will be set to `command` if not specified.
1078-
* `stdio` {string|Array} Child's stdio configuration.
1078+
* `stdio` {string|Array} Child's stdio configuration. **Default:** `'pipe'`.
10791079
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
10801080
* `uid` {number} Sets the user identity of the process (see setuid(2)).
10811081
* `gid` {number} Sets the group identity of the process (see setgid(2)).

0 commit comments

Comments
 (0)