Skip to content

Commit 3fd7edd

Browse files
Andrew Stuckicjihrig
Andrew Stucki
authored andcommitted
doc: add windowsVerbatimArguments docs
doc: Add windowsVerbatimArguments docs for child_process spawn, spawnSync, execFile, and fork PR-URL: #16299 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent f3a65a8 commit 3fd7edd

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/api/child_process.md

+10
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,8 @@ changes:
264264
* `gid` {number} Sets the group identity of the process (see setgid(2)).
265265
* `windowsHide` {boolean} Hide the subprocess console window that would
266266
normally be created on Windows systems. **Default:** `false`.
267+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
268+
done on Windows. Ignored on Unix. **Default:** `false`.
267269
* `callback` {Function} Called with the output when process terminates.
268270
* `error` {Error}
269271
* `stdout` {string|Buffer}
@@ -338,6 +340,8 @@ changes:
338340
When this option is provided, it overrides `silent`. If the array variant
339341
is used, it must contain exactly one item with value `'ipc'` or an error
340342
will be thrown. For instance `[0, 1, 2, 'ipc']`.
343+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
344+
done on Windows. Ignored on Unix. **Default:** `false`.
341345
* `uid` {number} Sets the user identity of the process (see setuid(2)).
342346
* `gid` {number} Sets the group identity of the process (see setgid(2)).
343347
* Returns: {ChildProcess}
@@ -404,6 +408,9 @@ changes:
404408
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
405409
shell can be specified as a string. See [Shell Requirements][] and
406410
[Default Windows Shell][]. **Default:** `false` (no shell).
411+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
412+
done on Windows. Ignored on Unix. This is set to `true` automatically
413+
when `shell` is specified. **Default:** `false`.
407414
* `windowsHide` {boolean} Hide the subprocess console window that would
408415
normally be created on Windows systems. **Default:** `false`.
409416
* Returns: {ChildProcess}
@@ -813,6 +820,9 @@ changes:
813820
`'/bin/sh'` on UNIX, and `process.env.ComSpec` on Windows. A different
814821
shell can be specified as a string. See [Shell Requirements][] and
815822
[Default Windows Shell][]. **Default:** `false` (no shell).
823+
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
824+
done on Windows. Ignored on Unix. This is set to `true` automatically
825+
when `shell` is specified. **Default:** `false`.
816826
* `windowsHide` {boolean} Hide the subprocess console window that would
817827
normally be created on Windows systems. **Default:** `false`.
818828
* Returns: {Object}

0 commit comments

Comments
 (0)