mirror of
https://github.com/nodejs/node.git
synced 2024-11-29 23:16:30 +01:00
c6656db352
In several places throughout the code we write directly to stderr to report warnings (deprecation, possible eventemitter memory leak). The current design of simply dumping the text to stderr is less than ideal. This PR introduces a new "process warnings" mechanism that emits 'warning' events on the global process object. These are invoked with a `warning` argument whose value is an Error object. By default, these warnings will be printed to stderr. This can be suppressed using the `--no-warnings` and `--no-deprecation` command line flags. For warnings, the 'warning' event will still be emitted by the process, allowing applications to handle the warnings in custom ways. The existing `--no-deprecation` flag will continue to supress all deprecation output generated by the core lib. The `--trace-warnings` command line flag will tell Node.js to print the full stack trace of warnings as part of the default handling. The existing `--no-deprecation`, `--throw-deprecation` and `--trace-deprecation` flags continue to work as they currently do, but the exact output of the warning message is modified to occur on process.nextTick(). The stack trace for the warnings and deprecations preserve and point to the correct call site. A new `process.emitWarning()` API is provided to permit userland to emit warnings and deprecations using the same consistent mechanism. Test cases and documentation are included. PR-URL: https://github.com/nodejs/node/pull/4782 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Wyatt Preul <wpreul@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
173 lines
3.4 KiB
Markdown
173 lines
3.4 KiB
Markdown
# Command Line Options
|
|
|
|
<!--type=misc-->
|
|
|
|
Node.js comes with a wide variety of CLI options. These options expose built-in
|
|
debugging, multiple ways to execute scripts, and other helpful runtime options.
|
|
|
|
To view this documentation as a manual page in your terminal, run `man node`.
|
|
|
|
|
|
## Synopsis
|
|
|
|
`node [options] [v8 options] [script.js | -e "script"] [arguments]`
|
|
|
|
`node debug [script.js | -e "script" | <host>:<port>] …`
|
|
|
|
`node --v8-options`
|
|
|
|
Execute without arguments to start the [REPL][].
|
|
|
|
_For more info about `node debug`, please see the [debugger][] documentation._
|
|
|
|
|
|
## Options
|
|
|
|
### `-v`, `--version`
|
|
|
|
Print node's version.
|
|
|
|
|
|
### `-h`, `--help`
|
|
|
|
Print node command line options.
|
|
The output of this option is less detailed than this document.
|
|
|
|
|
|
### `-e`, `--eval "script"`
|
|
|
|
Evaluate the following argument as JavaScript.
|
|
|
|
|
|
### `-p`, `--print "script"`
|
|
|
|
Identical to `-e` but prints the result.
|
|
|
|
|
|
### `-c`, `--check`
|
|
|
|
Syntax check the script without executing.
|
|
|
|
|
|
### `-i`, `--interactive`
|
|
|
|
Opens the REPL even if stdin does not appear to be a terminal.
|
|
|
|
|
|
### `-r`, `--require module`
|
|
|
|
Preload the specified module at startup.
|
|
|
|
Follows `require()`'s module resolution
|
|
rules. `module` may be either a path to a file, or a node module name.
|
|
|
|
|
|
### `--no-deprecation`
|
|
|
|
Silence deprecation warnings.
|
|
|
|
|
|
### `--trace-deprecation`
|
|
|
|
Print stack traces for deprecations.
|
|
|
|
|
|
### `--throw-deprecation`
|
|
|
|
Throw errors for deprecations.
|
|
|
|
### `--no-warnings`
|
|
|
|
Silence all process warnings (including deprecations).
|
|
|
|
### `--trace-warnings`
|
|
|
|
Print stack traces for process warnings (including deprecations).
|
|
|
|
### `--trace-sync-io`
|
|
|
|
Prints a stack trace whenever synchronous I/O is detected after the first turn
|
|
of the event loop.
|
|
|
|
|
|
### `--zero-fill-buffers`
|
|
|
|
Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]
|
|
instances.
|
|
|
|
|
|
### `--track-heap-objects`
|
|
|
|
Track heap object allocations for heap snapshots.
|
|
|
|
|
|
### `--prof-process`
|
|
|
|
Process v8 profiler output generated using the v8 option `--prof`.
|
|
|
|
|
|
### `--v8-options`
|
|
|
|
Print v8 command line options.
|
|
|
|
|
|
### `--tls-cipher-list=list`
|
|
|
|
Specify an alternative default TLS cipher list. (Requires Node.js to be built
|
|
with crypto support. (Default))
|
|
|
|
|
|
### `--enable-fips`
|
|
|
|
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
|
|
`./configure --openssl-fips`)
|
|
|
|
|
|
### `--force-fips`
|
|
|
|
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
|
|
(Same requirements as `--enable-fips`)
|
|
|
|
|
|
### `--icu-data-dir=file`
|
|
|
|
Specify ICU data load path. (overrides `NODE_ICU_DATA`)
|
|
|
|
|
|
## Environment Variables
|
|
|
|
### `NODE_DEBUG=module[,…]`
|
|
|
|
`','`-separated list of core modules that should print debug information.
|
|
|
|
|
|
### `NODE_PATH=path[:…]`
|
|
|
|
`':'`-separated list of directories prefixed to the module search path.
|
|
|
|
_Note: on Windows, this is a `';'`-separated list instead._
|
|
|
|
|
|
### `NODE_DISABLE_COLORS=1`
|
|
|
|
When set to `1` colors will not be used in the REPL.
|
|
|
|
|
|
### `NODE_ICU_DATA=file`
|
|
|
|
Data path for ICU (Intl object) data. Will extend linked-in data when compiled
|
|
with small-icu support.
|
|
|
|
|
|
### `NODE_REPL_HISTORY=file`
|
|
|
|
Path to the file used to store the persistent REPL history. The default path is
|
|
`~/.node_repl_history`, which is overridden by this variable. Setting the value
|
|
to an empty string (`""` or `" "`) disables persistent REPL history.
|
|
|
|
|
|
[Buffer]: buffer.html#buffer_buffer
|
|
[debugger]: debugger.html
|
|
[REPL]: repl.html
|
|
[SlowBuffer]: buffer.html#buffer_class_slowbuffer
|