Skip to content

Commit 2fc3e4d

Browse files
author
Andrew Stucki
committed
doc: Add windowsVerbatimArguments docs for child_process spawn, spawnSync, execFile, and fork
1 parent 70832bc commit 2fc3e4d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/api/child_process.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,8 @@ changes:
265265
* `gid` {number} Sets the group identity of the process (see setgid(2)).
266266
* `windowsHide` {boolean} Hide the subprocess console window that would
267267
normally be created on Windows systems. **Default:** `false`.
268+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
269+
done on Windows. Ignored on Unix. **Default:** `false`.
268270
* `callback` {Function} Called with the output when process terminates.
269271
* `error` {Error}
270272
* `stdout` {string|Buffer}
@@ -339,6 +341,8 @@ changes:
339341
When this option is provided, it overrides `silent`. If the array variant
340342
is used, it must contain exactly one item with value `'ipc'` or an error
341343
will be thrown. For instance `[0, 1, 2, 'ipc']`.
344+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
345+
done on Windows. Ignored on Unix. **Default:** `false`.
342346
* `uid` {number} Sets the user identity of the process (see setuid(2)).
343347
* `gid` {number} Sets the group identity of the process (see setgid(2)).
344348
* Returns: {ChildProcess}
@@ -405,6 +409,9 @@ changes:
405409
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
406410
shell can be specified as a string. See [Shell Requirements][] and
407411
[Default Windows Shell][]. **Default:** `false` (no shell).
412+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
413+
done on Windows. Ignored on Unix. This is set to `true` automatically
414+
when `shell` is specified. **Default:** `false`.
408415
* `windowsHide` {boolean} Hide the subprocess console window that would
409416
normally be created on Windows systems. **Default:** `false`.
410417
* Returns: {ChildProcess}
@@ -814,6 +821,9 @@ changes:
814821
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
815822
shell can be specified as a string. See [Shell Requirements][] and
816823
[Default Windows Shell][]. **Default:** `false` (no shell).
824+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
825+
done on Windows. Ignored on Unix. This is set to `true` automatically
826+
when `shell` is specified. **Default:** `false`.
817827
* `windowsHide` {boolean} Hide the subprocess console window that would
818828
normally be created on Windows systems. **Default:** `false`.
819829
* Returns: {Object}

0 commit comments

Comments
 (0)