BackPup/node
1
0 Fork 0
mirror of https://github.com/nodejs/node.git synced 2026-10-14 10:26:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc: describe NODE_OPTIONS interop w/cmd line opts

Browse Source 
Fixes https://github.com/nodejs/node/issues/28910

PR-URL: https://github.com/nodejs/node/pull/28928
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This commit is contained in:
Alex Aubuchon authored and Rich Trott committed 2019-08-03 20:39:43 -07:00
1 parent e6c205265a
commit 5eaef7b915
1 file changed
+26 -7
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/cli.md
+26 -7
View File
@@ -950,16 +950,35 @@ When set to `1`, process warnings are silenced.
added: v8.0.0
-->
A space-separated list of command line options. `options...` are interpreted as
if they had been specified on the command line before the actual command line
(so they can be overridden). Node.js will exit with an error if an option
that is not allowed in the environment is used, such as `-p` or a script file.
A space-separated list of command line options. `options...` are interpreted
before command line options, so command line options will override or
compound after anything in `options...`. Node.js will exit with an error if
an option that is not allowed in the environment is used, such as `-p` or a
script file.
In case an option value happens to contain a space (for example a path listed in
`--require`), it must be escaped using double quotes. For example:
In case an option value happens to contain a space (for example a path listed
in `--require`), it must be escaped using double quotes. For example:
```bash
--require "./my path/file.js"
NODE_OPTIONS='--require "./my path/file.js"'
```
A singleton flag passed as a command line option will override the same flag
passed into `NODE_OPTIONS`:
```bash
# The inspector will be available on port 5555
NODE_OPTIONS='--inspect=localhost:4444' node --inspect=localhost:5555
```
A flag that can be passed multiple times will be treated as if its
`NODE_OPTIONS` instances were passed first, and then its command line
instances afterwards:
```bash
NODE_OPTIONS='--require "./a.js"' node --require "./b.js"
# is equivalent to:
node --require "./a.js" --require "./b.js"
```
Node.js options that are allowed are: