1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add windowsVerbatimArguments docs

Browse Source 
doc: Add windowsVerbatimArguments docs for
child_process spawn, spawnSync, execFile, and fork

PR-URL: https://github.com/nodejs/node/pull/16299
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Andrew Stucki 2017-10-18 12:33:27 -05:00 committed by Joyee Cheung
parent 635d06442d
commit 41611f9adb
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/child_process.md
View File

@ -264,6 +264,8 @@ changes:
* `gid` {number} Sets the group identity of the process (see setgid(2)). * `gid` {number} Sets the group identity of the process (see setgid(2)).
* `windowsHide` {boolean} Hide the subprocess console window that would * `windowsHide` {boolean} Hide the subprocess console window that would
normally be created on Windows systems. **Default:** `false`. normally be created on Windows systems. **Default:** `false`.
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. **Default:** `false`.
* `callback` {Function} Called with the output when process terminates. * `callback` {Function} Called with the output when process terminates.
* `error` {Error} * `error` {Error}
* `stdout` {string|Buffer} * `stdout` {string|Buffer}
@ -338,6 +340,8 @@ changes:
When this option is provided, it overrides `silent`. If the array variant When this option is provided, it overrides `silent`. If the array variant
is used, it must contain exactly one item with value `'ipc'` or an error is used, it must contain exactly one item with value `'ipc'` or an error
will be thrown. For instance `[0, 1, 2, 'ipc']`. will be thrown. For instance `[0, 1, 2, 'ipc']`.
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. **Default:** `false`.
* `uid` {number} Sets the user identity of the process (see setuid(2)). * `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)). * `gid` {number} Sets the group identity of the process (see setgid(2)).
* Returns: {ChildProcess} * Returns: {ChildProcess}
@ -404,6 +408,9 @@ changes:
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different `'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell Requirements][] and shell can be specified as a string. See [Shell Requirements][] and
[Default Windows Shell][]. **Default:** `false` (no shell). [Default Windows Shell][]. **Default:** `false` (no shell).
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. This is set to `true` automatically
when `shell` is specified. **Default:** `false`.
* `windowsHide` {boolean} Hide the subprocess console window that would * `windowsHide` {boolean} Hide the subprocess console window that would
normally be created on Windows systems. **Default:** `false`. normally be created on Windows systems. **Default:** `false`.
* Returns: {ChildProcess} * Returns: {ChildProcess}
@ -813,6 +820,9 @@ changes:
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different `'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
shell can be specified as a string. See [Shell Requirements][] and shell can be specified as a string. See [Shell Requirements][] and
[Default Windows Shell][]. **Default:** `false` (no shell). [Default Windows Shell][]. **Default:** `false` (no shell).
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
done on Windows. Ignored on Unix. This is set to `true` automatically
when `shell` is specified. **Default:** `false`.
* `windowsHide` {boolean} Hide the subprocess console window that would * `windowsHide` {boolean} Hide the subprocess console window that would
normally be created on Windows systems. **Default:** `false`. normally be created on Windows systems. **Default:** `false`.
* Returns: {Object} * Returns: {Object}