Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add missing windowsVerbatimArguments option in child_process.spawn #7884

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ added: v0.1.90
* `options` {Object}
* `cwd` {String} Current working directory of the child process
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `encoding` {String} (Default: `'utf8'`)
* `shell` {String} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should
Expand Down Expand Up @@ -198,6 +200,8 @@ added: v0.1.91
* `options` {Object}
* `cwd` {String} Current working directory of the child process
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `encoding` {String} (Default: `'utf8'`)
* `timeout` {Number} (Default: `0`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
Expand Down Expand Up @@ -246,6 +250,8 @@ added: v0.5.0
* `options` {Object}
* `cwd` {String} Current working directory of the child process
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `execPath` {String} Executable used to create the child process
* `execArgv` {Array} List of string arguments passed to the executable
(Default: `process.execArgv`)
Expand Down Expand Up @@ -295,6 +301,8 @@ added: v0.1.90
* `options` {Object}
* `cwd` {String} Current working directory of the child process
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `stdio` {Array|String} Child's stdio configuration. (See
[`options.stdio`][`stdio`])
* `detached` {Boolean} Prepare child to run independently of its parent
Expand Down Expand Up @@ -559,6 +567,8 @@ added: v0.11.12
- `stderr` by default will be output to the parent process' stderr unless
`stdio` is specified
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {Number} In milliseconds the maximum amount of time the process
Expand Down Expand Up @@ -597,6 +607,8 @@ added: v0.11.12
- `stderr` by default will be output to the parent process' stderr unless
`stdio` is specified
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `shell` {String} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should
understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
Expand Down Expand Up @@ -639,6 +651,8 @@ added: v0.11.12
- supplying this value will override `stdio[0]`
* `stdio` {Array} Child's stdio configuration.
* `env` {Object} Environment key-value pairs
* `windowsVerbatimArguments` {Boolean} Disable unix-like argument formatting and
instead use only spaces to separate provided arguments
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {Number} In milliseconds the maximum amount of time the process
Expand Down