Node.js configuration
The Node.js configuration file
| Type | object |
|---|---|
| File match |
node.config.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/node-js-configuration/latest.json |
| Source | https://nodejs.org/docs/latest/node-config-schema.json |
Validate with Lintel
npx @lintel/lintel check
Properties
146 nested properties
disable loading native addons
allow use of addons when any permissions are set
allow use of child process when any permissions are set
allow permissions to read the filesystem
allow permissions to write in the filesystem
allow use of inspector when any permissions are set
allow use of network when any permissions are set
allow wasi when any permissions are set
allow worker threads when any permissions are set
Improve AsyncLocalStorage performance with AsyncContextFrame
additional user conditions for conditional exports and imports
Start the V8 CPU profiler on start up, and write the CPU profile to disk before exit. If --cpu-prof-dir is not specified, write the profile to the current working directory.
Directory where the V8 profiles generated by --cpu-prof will be placed. Does not affect --prof.
specified sampling interval in microseconds for the V8 CPU profile generated with --cpu-prof. (default: 1000)
specified file name of the V8 CPU profile generated with --cpu-prof
silence deprecation warnings
set dir for all output files (default: current working directory)
disable Object.prototype.proto
Disable inspector thread to be listening for SIGUSR1 signal
silence specific process warnings
Disable trap-handler-based WebAssembly bound checks. V8 will insert inline bound checks when compiling WebAssembly which may slow down performance.
set default value of verbatim in dns.lookup. Options are 'ipv4first' (IPv4 addresses are placed before IPv6 addresses) 'ipv6first' (IPv6 addresses are placed before IPv4 addresses) 'verbatim' (addresses are in the order the DNS resolver returned)
enable FIPS crypto at startup
Source Map V3 support for stack traces
Treat the entrypoint as a URL
experimental import support for addons
when ambiguous modules fail to evaluate because they contain ES module syntax, try again to evaluate them as ES modules
experimental EventSource API
expose experimental Navigator API on the global scope
experimental ES Module import.meta.resolve() parentURL support
use the specified module as a custom loader
Print pending top-level await. If --require-module is true, evaluate asynchronous graphs loaded by require() but do not run the microtasks, in order to to find and print top-level await in the graph
experimental await keyword support in REPL
Legacy alias for --require-module
experimental node:sqlite module
enable transformation of TypeScript-onlysyntax into JavaScript code
experimental ES Module support in vm module
experimental WebSocket API
experimental Web Storage API
hide extra information on fatal exception that causes exit
disable checks for async_hooks
disable loading non-context-aware addons
force FIPS crypto (cannot be disabled)
enforces 'uncaughtException' event on Node API asynchronous callbacks
experimental frozen intrinsics support
disable global module search paths
Start the V8 heap profiler on start up, and write the heap profile to disk before exit. If --heap-prof-dir is not specified, write the profile to the current working directory.
Directory where the V8 heap profiles generated by --heap-prof will be placed.
specified sampling interval in bytes for the V8 heap profile generated with --heap-prof. (default: 512 * 1024)
specified file name of the V8 heap profile generated with --heap-prof
Generate heap snapshots whenever V8 is approaching the heap limit. No more than the specified number of heap snapshots will be generated.
Generate heap snapshot on specified signal
set ICU data load path to dir (overrides NODE_ICU_DATA) (note: linked-in ICU data is present)
ES module to preload (option can be repeated)
set module type for string input
use an insecure HTTP parser that accepts invalid HTTP headers
activate inspector on host:port (default: 127.0.0.1:9229)
activate inspector on host:port and break at start of user script
set host:port for inspector
comma separated list of destinations for inspector uid(default: stderr,http)
activate inspector on host:port and wait for debugger to be attached
file used to persist localStorage data
set the maximum size of HTTP headers (default: 16384 (16KB))
set V8's max old space size as a percentage of available memory (e.g., '50%'). Takes precedence over --max-old-space-size.
Disable network address family autodetection algorithm
Sets the default value for the network family autoselection attempt timeout.
load OpenSSL configuration from the specified file (overrides OPENSSL_CONF)
enable OpenSSL 3.0 legacy provider
enable OpenSSL shared configuration
emit pending deprecation warnings
enable the permission system
preserve symbolic links when resolving
preserve symbolic links when resolving the main module
write warnings to file instead of stderr
output compact single-line JSON
define custom report pathname. (default: current working directory)
Exclude environment variables when generating report (default: false)
exclude network interface diagnostics. (default: false)
define custom report file name. (default: YYYYMMDD.HHMMSS.PID.SEQUENCE#.txt)
generate diagnostic report on fatal (internal) errors
generate diagnostic report upon receiving signals
causes diagnostic report to be produced on provided signal, unsupported in Windows. (default: SIGUSR2)
generate diagnostic report on uncaught exceptions
CommonJS module to preload (option can be repeated)
Allow loading synchronous ES Modules in require().
total size of the OpenSSL secure heap
minimum allocation size from the OpenSSL secure heap
Path to the snapshot blob that's either the result of snapshotbuilding, or the blob that is used to restore the application state
Type-stripping for TypeScript files.
the branch coverage minimum threshold
exclude files from coverage report that match this glob pattern
the function coverage minimum threshold
include files in coverage report that match this glob pattern
the line coverage minimum threshold
specifies the path to the global setup file
configures the type of test isolation used in the test runner
run tests whose name matches this regular expression
run tests with 'only' option set
report test output using the given reporter
report given reporter to the given destination
specifies the path to the rerun state file
run test at specific shard
run tests whose name do not match this regular expression
throw an exception on deprecations
the process title to use on startup
use an alternative default TLS cipher list
log TLS decryption keys to named file for traffic analysis
set default TLS maximum to TLSv1.2 (default: TLSv1.3)
set default TLS maximum to TLSv1.3 (default: TLSv1.3)
set default TLS minimum to TLSv1.0 (default: TLSv1.2)
set default TLS minimum to TLSv1.1 (default: TLSv1.2)
set default TLS minimum to TLSv1.2 (default: TLSv1.2)
set default TLS minimum to TLSv1.3 (default: TLSv1.2)
show stack traces on deprecations
Print accesses to the environment variables
Print accesses to the environment variables and the JavaScript stack trace
Print accesses to the environment variables and the native stack trace
comma separated list of trace event categories to record
Template string specifying the filepath for the trace-events data, it supports ${rotation} and ${pid}.
show stack trace when an environment exits
show stack traces on promise initialization and resolution
Print access to require(esm). Options are 'all' (print all usage) and 'no-node-modules' (excluding usage from the node_modules folder)
enable printing JavaScript stacktrace on SIGINT
show stack trace when use of sync IO is detected after the first tick
prints TLS packet trace information to stderr
show stack traces for the throw behind uncaught exceptions
show stack traces on process warnings
track heap object allocations for heap snapshots
define unhandled rejections behavior. Options are 'strict' (always raise an error), 'throw' (raise an error unless 'unhandledRejection' hook is set), 'warn' (log a warning), 'none' (silence warnings), 'warn-with-error-code' (log a warning and set exit code 1 unless 'unhandledRejection' hook is set). (default: throw)
use bundled CA store (default)
parse proxy settings from HTTP_PROXY/HTTPS_PROXY/NO_PROXYenvironment variables and apply the setting in global HTTP/HTTPS clients
Map the Node.js static code to large pages. Options are 'off' (the default value, meaning do not map), 'on' (map and ignore failure, reporting it to stderr), or 'silent' (map and silently ignore failure)
use OpenSSL's default CA store
use system's CA store
set V8's thread pool size
silence all process warnings
run in watch mode
kill signal to send to the process on watch mode restarts(default: SIGTERM)
path to watch
preserve outputs on watch mode restart
automatically zero-fill all newly allocated Buffer instances
9 nested properties
allow use of addons when any permissions are set
allow use of child process when any permissions are set
allow permissions to read the filesystem
allow permissions to write in the filesystem
allow use of inspector when any permissions are set
allow use of network when any permissions are set
allow wasi when any permissions are set
allow worker threads when any permissions are set
enable the permission system
21 nested properties
enable code coverage in the test runner
enable module mocking in the test runner
launch test runner on startup
specify test runner concurrency
the branch coverage minimum threshold
exclude files from coverage report that match this glob pattern
the function coverage minimum threshold
include files in coverage report that match this glob pattern
the line coverage minimum threshold
force test runner to exit upon completion
specifies the path to the global setup file
configures the type of test isolation used in the test runner
run tests whose name matches this regular expression
run tests with 'only' option set
report test output using the given reporter
report given reporter to the given destination
specifies the path to the rerun state file
run test at specific shard
run tests whose name do not match this regular expression
specify test runner timeout
regenerate test snapshots
4 nested properties
run in watch mode
kill signal to send to the process on watch mode restarts(default: SIGTERM)
path to watch
preserve outputs on watch mode restart