Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2017-09-13 07:22:45 +0300
committerMyles Borins <mylesborins@google.com>2017-10-24 07:07:31 +0300
commit81d01bccd1433f475d97ce44b6b2abe104b7fcf2 (patch)
treebd171f67cd79abc4c767a9325ab10d3644868454 /doc
parentff25ca70b258a0ef1dccdfee3302a727ed51ee21 (diff)
child_process: add windowsHide option
This commit exposes the UV_PROCESS_WINDOWS_HIDE flag in Node as a windowsHide option to the child_process methods. The option is only applicable to Windows, and is ignored elsewhere. Backport-PR-URL: https://github.com/nodejs/node/pull/16425 Fixes: https://github.com/nodejs/node/issues/15217 PR-URL: https://github.com/nodejs/node/pull/15380 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/api/child_process.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index c3fd876d4f7..3e7413c0712 100755
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -127,6 +127,10 @@ exec('"my script.cmd" a b', (err, stdout, stderr) => {
### child_process.exec(command[, options][, callback])
<!-- YAML
added: v0.1.90
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
-->
* `command` {string} The command to run, with space-separated arguments.
@@ -144,6 +148,8 @@ added: v0.1.90
* `killSignal` {string|integer} **Default:** `'SIGTERM'`
* `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)).
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* `callback` {Function} called with the output when process terminates.
* `error` {Error}
* `stdout` {string|Buffer}
@@ -237,6 +243,10 @@ lsExample();
### child_process.execFile(file[, args][, options][, callback])
<!-- YAML
added: v0.1.91
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
-->
* `file` {string} The name or path of the executable file to run.
@@ -252,6 +262,8 @@ added: v0.1.91
* `killSignal` {string|integer} **Default:** `'SIGTERM'`
* `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)).
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* `callback` {Function} Called with the output when process terminates.
* `error` {Error}
* `stdout` {string|Buffer}
@@ -363,6 +375,9 @@ supported by `child_process.fork()` and will be ignored if set.
<!-- YAML
added: v0.1.90
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
- version: v6.4.0
pr-url: https://github.com/nodejs/node/pull/7696
description: The `argv0` option is supported now.
@@ -389,6 +404,8 @@ changes:
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell Requirements][] and
[Default Windows Shell][]. **Default:** `false` (no shell).
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* Returns: {ChildProcess}
The `child_process.spawn()` method spawns a new process using the given
@@ -648,6 +665,9 @@ configuration at startup.
<!-- YAML
added: v0.11.12
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10653
description: The `input` option can now be a `Uint8Array`.
@@ -677,6 +697,8 @@ changes:
stderr. **Default:** `200*1024` If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
* `encoding` {string} The encoding used for all stdio inputs and outputs. **Default:** `'buffer'`
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* Returns: {Buffer|string} The stdout from the command.
The `child_process.execFileSync()` method is generally identical to
@@ -697,6 +719,9 @@ throw an [`Error`][] that will include the full result of the underlying
<!-- YAML
added: v0.11.12
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10653
description: The `input` option can now be a `Uint8Array`.
@@ -726,6 +751,8 @@ changes:
See caveat at [`maxBuffer` and Unicode][].
* `encoding` {string} The encoding used for all stdio inputs and outputs.
**Default:** `'buffer'`
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* Returns: {Buffer|string} The stdout from the command.
The `child_process.execSync()` method is generally identical to
@@ -748,6 +775,9 @@ execution.
<!-- YAML
added: v0.11.12
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/15380
+ description: The `windowsHide` option is supported now.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10653
description: The `input` option can now be a `Uint8Array`.
@@ -783,6 +813,8 @@ changes:
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell Requirements][] and
[Default Windows Shell][]. **Default:** `false` (no shell).
+ * `windowsHide` {boolean} Hide the subprocess console window that would
+ normally be created on Windows systems. **Default:** `false`.
* Returns: {Object}
* `pid` {number} Pid of the child process.
* `output` {Array} Array of results from stdio output.