From 9f8bea3dda2ecf304aec8e55a712a496470b1dcb Mon Sep 17 00:00:00 2001 From: Ariel Weiss Date: Thu, 7 Sep 2023 00:08:18 +0300 Subject: [PATCH] doc: fix documentation for input option in child_process PR-URL: https://github.com/nodejs/node/pull/49481 Fixes: https://github.com/nodejs/node/issues/49417 Reviewed-By: Benjamin Gruenbaum Reviewed-By: Chemi Atlow --- doc/api/child_process.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index a32917997d37f1..f33fc8b18ded3e 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -925,8 +925,8 @@ changes: * `options` {Object} * `cwd` {string|URL} Current working directory of the child process. * `input` {string|Buffer|TypedArray|DataView} The value which will be passed - as stdin to the spawned process. Supplying this value will override - `stdio[0]`. + as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying + this value will override `stdio[0]`. * `stdio` {string|Array} Child's stdio configuration. `stderr` by default will be output to the parent process' stderr unless `stdio` is specified. **Default:** `'pipe'`. @@ -995,8 +995,8 @@ changes: * `options` {Object} * `cwd` {string|URL} Current working directory of the child process. * `input` {string|Buffer|TypedArray|DataView} The value which will be passed - as stdin to the spawned process. Supplying this value will override - `stdio[0]`. + as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying + this value will override `stdio[0]`. * `stdio` {string|Array} Child's stdio configuration. `stderr` by default will be output to the parent process' stderr unless `stdio` is specified. **Default:** `'pipe'`. @@ -1071,11 +1071,11 @@ changes: * `options` {Object} * `cwd` {string|URL} Current working directory of the child process. * `input` {string|Buffer|TypedArray|DataView} The value which will be passed - as stdin to the spawned process. Supplying this value will override - `stdio[0]`. + as stdin to the spawned process. If `stdio[0]` is set to `'pipe'`, Supplying + this value will override `stdio[0]`. * `argv0` {string} Explicitly set the value of `argv[0]` sent to the child process. This will be set to `command` if not specified. - * `stdio` {string|Array} Child's stdio configuration. + * `stdio` {string|Array} Child's stdio configuration. **Default:** `'pipe'`. * `env` {Object} Environment key-value pairs. **Default:** `process.env`. * `uid` {number} Sets the user identity of the process (see setuid(2)). * `gid` {number} Sets the group identity of the process (see setgid(2)).