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
Type: object

Properties

$schema string
nodeOptions object
146 nested properties
addons boolean

disable loading native addons

allow-addons boolean

allow use of addons when any permissions are set

allow-child-process boolean

allow use of child process when any permissions are set

allow-fs-read string | string[]

allow permissions to read the filesystem

allow-fs-write string | string[]

allow permissions to write in the filesystem

allow-inspector boolean

allow use of inspector when any permissions are set

allow-net boolean

allow use of network when any permissions are set

allow-wasi boolean

allow wasi when any permissions are set

allow-worker boolean

allow worker threads when any permissions are set

async-context-frame boolean

Improve AsyncLocalStorage performance with AsyncContextFrame

conditions string | string[]

additional user conditions for conditional exports and imports

cpu-prof boolean

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.

cpu-prof-dir string

Directory where the V8 profiles generated by --cpu-prof will be placed. Does not affect --prof.

cpu-prof-interval number

specified sampling interval in microseconds for the V8 CPU profile generated with --cpu-prof. (default: 1000)

cpu-prof-name string

specified file name of the V8 CPU profile generated with --cpu-prof

debug-arraybuffer-allocations boolean
deprecation boolean

silence deprecation warnings

diagnostic-dir string

set dir for all output files (default: current working directory)

disable-proto string

disable Object.prototype.proto

disable-sigusr1 boolean

Disable inspector thread to be listening for SIGUSR1 signal

disable-warning string | string[]

silence specific process warnings

disable-wasm-trap-handler boolean

Disable trap-handler-based WebAssembly bound checks. V8 will insert inline bound checks when compiling WebAssembly which may slow down performance.

dns-result-order string

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 boolean

enable FIPS crypto at startup

enable-source-maps boolean

Source Map V3 support for stack traces

entry-url boolean

Treat the entrypoint as a URL

experimental-addon-modules boolean

experimental import support for addons

experimental-detect-module boolean

when ambiguous modules fail to evaluate because they contain ES module syntax, try again to evaluate them as ES modules

experimental-eventsource boolean

experimental EventSource API

experimental-global-navigator boolean

expose experimental Navigator API on the global scope

experimental-import-meta-resolve boolean

experimental ES Module import.meta.resolve() parentURL support

experimental-loader string | string[]

use the specified module as a custom loader

experimental-print-required-tla boolean

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-repl-await boolean

experimental await keyword support in REPL

experimental-require-module boolean

Legacy alias for --require-module

experimental-shadow-realm boolean
experimental-sqlite boolean

experimental node:sqlite module

experimental-transform-types boolean

enable transformation of TypeScript-onlysyntax into JavaScript code

experimental-vm-modules boolean

experimental ES Module support in vm module

experimental-websocket boolean

experimental WebSocket API

experimental-webstorage boolean

experimental Web Storage API

extra-info-on-fatal-exception boolean

hide extra information on fatal exception that causes exit

force-async-hooks-checks boolean

disable checks for async_hooks

force-context-aware boolean

disable loading non-context-aware addons

force-fips boolean

force FIPS crypto (cannot be disabled)

force-node-api-uncaught-exceptions-policy boolean

enforces 'uncaughtException' event on Node API asynchronous callbacks

frozen-intrinsics boolean

experimental frozen intrinsics support

global-search-paths boolean

disable global module search paths

heap-prof boolean

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.

heap-prof-dir string

Directory where the V8 heap profiles generated by --heap-prof will be placed.

heap-prof-interval number

specified sampling interval in bytes for the V8 heap profile generated with --heap-prof. (default: 512 * 1024)

heap-prof-name string

specified file name of the V8 heap profile generated with --heap-prof

heapsnapshot-near-heap-limit number

Generate heap snapshots whenever V8 is approaching the heap limit. No more than the specified number of heap snapshots will be generated.

heapsnapshot-signal string

Generate heap snapshot on specified signal

icu-data-dir string

set ICU data load path to dir (overrides NODE_ICU_DATA) (note: linked-in ICU data is present)

import string | string[]

ES module to preload (option can be repeated)

input-type string

set module type for string input

insecure-http-parser boolean

use an insecure HTTP parser that accepts invalid HTTP headers

inspect boolean

activate inspector on host:port (default: 127.0.0.1:9229)

inspect-brk boolean

activate inspector on host:port and break at start of user script

inspect-port number

set host:port for inspector

inspect-publish-uid string

comma separated list of destinations for inspector uid(default: stderr,http)

inspect-wait boolean

activate inspector on host:port and wait for debugger to be attached

localstorage-file string

file used to persist localStorage data

max-http-header-size number

set the maximum size of HTTP headers (default: 16384 (16KB))

max-old-space-size-percentage string

set V8's max old space size as a percentage of available memory (e.g., '50%'). Takes precedence over --max-old-space-size.

network-family-autoselection boolean

Disable network address family autodetection algorithm

network-family-autoselection-attempt-timeout number

Sets the default value for the network family autoselection attempt timeout.

node-snapshot boolean
openssl-config string

load OpenSSL configuration from the specified file (overrides OPENSSL_CONF)

openssl-legacy-provider boolean

enable OpenSSL 3.0 legacy provider

openssl-shared-config boolean

enable OpenSSL shared configuration

pending-deprecation boolean

emit pending deprecation warnings

permission boolean

enable the permission system

preserve-symlinks boolean

preserve symbolic links when resolving

preserve-symlinks-main boolean

preserve symbolic links when resolving the main module

redirect-warnings string

write warnings to file instead of stderr

report-compact boolean

output compact single-line JSON

report-dir string

define custom report pathname. (default: current working directory)

report-exclude-env boolean

Exclude environment variables when generating report (default: false)

report-exclude-network boolean

exclude network interface diagnostics. (default: false)

report-filename string

define custom report file name. (default: YYYYMMDD.HHMMSS.PID.SEQUENCE#.txt)

report-on-fatalerror boolean

generate diagnostic report on fatal (internal) errors

report-on-signal boolean

generate diagnostic report upon receiving signals

report-signal string

causes diagnostic report to be produced on provided signal, unsupported in Windows. (default: SIGUSR2)

report-uncaught-exception boolean

generate diagnostic report on uncaught exceptions

require string | string[]

CommonJS module to preload (option can be repeated)

require-module boolean

Allow loading synchronous ES Modules in require().

secure-heap number

total size of the OpenSSL secure heap

secure-heap-min number

minimum allocation size from the OpenSSL secure heap

snapshot-blob string

Path to the snapshot blob that's either the result of snapshotbuilding, or the blob that is used to restore the application state

stack-trace-limit number
strip-types boolean

Type-stripping for TypeScript files.

test-coverage-branches number

the branch coverage minimum threshold

test-coverage-exclude string | string[]

exclude files from coverage report that match this glob pattern

test-coverage-functions number

the function coverage minimum threshold

test-coverage-include string | string[]

include files in coverage report that match this glob pattern

test-coverage-lines number

the line coverage minimum threshold

test-global-setup string

specifies the path to the global setup file

test-isolation string

configures the type of test isolation used in the test runner

test-name-pattern string | string[]

run tests whose name matches this regular expression

test-only boolean

run tests with 'only' option set

test-reporter string | string[]

report test output using the given reporter

test-reporter-destination string | string[]

report given reporter to the given destination

test-rerun-failures string

specifies the path to the rerun state file

test-shard string

run test at specific shard

test-skip-pattern string | string[]

run tests whose name do not match this regular expression

throw-deprecation boolean

throw an exception on deprecations

title string

the process title to use on startup

tls-cipher-list string

use an alternative default TLS cipher list

tls-keylog string

log TLS decryption keys to named file for traffic analysis

tls-max-v1.2 boolean

set default TLS maximum to TLSv1.2 (default: TLSv1.3)

tls-max-v1.3 boolean

set default TLS maximum to TLSv1.3 (default: TLSv1.3)

tls-min-v1.0 boolean

set default TLS minimum to TLSv1.0 (default: TLSv1.2)

tls-min-v1.1 boolean

set default TLS minimum to TLSv1.1 (default: TLSv1.2)

tls-min-v1.2 boolean

set default TLS minimum to TLSv1.2 (default: TLSv1.2)

tls-min-v1.3 boolean

set default TLS minimum to TLSv1.3 (default: TLSv1.2)

trace-deprecation boolean

show stack traces on deprecations

trace-env boolean

Print accesses to the environment variables

trace-env-js-stack boolean

Print accesses to the environment variables and the JavaScript stack trace

trace-env-native-stack boolean

Print accesses to the environment variables and the native stack trace

trace-event-categories string

comma separated list of trace event categories to record

trace-event-file-pattern string

Template string specifying the filepath for the trace-events data, it supports ${rotation} and ${pid}.

trace-exit boolean

show stack trace when an environment exits

trace-promises boolean

show stack traces on promise initialization and resolution

trace-require-module string

Print access to require(esm). Options are 'all' (print all usage) and 'no-node-modules' (excluding usage from the node_modules folder)

trace-sigint boolean

enable printing JavaScript stacktrace on SIGINT

trace-sync-io boolean

show stack trace when use of sync IO is detected after the first tick

trace-tls boolean

prints TLS packet trace information to stderr

trace-uncaught boolean

show stack traces for the throw behind uncaught exceptions

trace-warnings boolean

show stack traces on process warnings

track-heap-objects boolean

track heap object allocations for heap snapshots

unhandled-rejections string

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 boolean

use bundled CA store (default)

use-env-proxy boolean

parse proxy settings from HTTP_PROXY/HTTPS_PROXY/NO_PROXYenvironment variables and apply the setting in global HTTP/HTTPS clients

use-largepages string

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-ca boolean

use OpenSSL's default CA store

use-system-ca boolean

use system's CA store

v8-pool-size number

set V8's thread pool size

verify-base-objects boolean
warnings boolean

silence all process warnings

watch boolean

run in watch mode

watch-kill-signal string

kill signal to send to the process on watch mode restarts(default: SIGTERM)

watch-path string | string[]

path to watch

watch-preserve-output boolean

preserve outputs on watch mode restart

zero-fill-buffers boolean

automatically zero-fill all newly allocated Buffer instances

permission object
9 nested properties
allow-addons boolean

allow use of addons when any permissions are set

allow-child-process boolean

allow use of child process when any permissions are set

allow-fs-read string | string[]

allow permissions to read the filesystem

allow-fs-write string | string[]

allow permissions to write in the filesystem

allow-inspector boolean

allow use of inspector when any permissions are set

allow-net boolean

allow use of network when any permissions are set

allow-wasi boolean

allow wasi when any permissions are set

allow-worker boolean

allow worker threads when any permissions are set

permission boolean

enable the permission system

test object
21 nested properties
experimental-test-coverage boolean

enable code coverage in the test runner

experimental-test-module-mocks boolean

enable module mocking in the test runner

test boolean

launch test runner on startup

test-concurrency number

specify test runner concurrency

test-coverage-branches number

the branch coverage minimum threshold

test-coverage-exclude string | string[]

exclude files from coverage report that match this glob pattern

test-coverage-functions number

the function coverage minimum threshold

test-coverage-include string | string[]

include files in coverage report that match this glob pattern

test-coverage-lines number

the line coverage minimum threshold

test-force-exit boolean

force test runner to exit upon completion

test-global-setup string

specifies the path to the global setup file

test-isolation string

configures the type of test isolation used in the test runner

test-name-pattern string | string[]

run tests whose name matches this regular expression

test-only boolean

run tests with 'only' option set

test-reporter string | string[]

report test output using the given reporter

test-reporter-destination string | string[]

report given reporter to the given destination

test-rerun-failures string

specifies the path to the rerun state file

test-shard string

run test at specific shard

test-skip-pattern string | string[]

run tests whose name do not match this regular expression

test-timeout number

specify test runner timeout

test-update-snapshots boolean

regenerate test snapshots

watch object
4 nested properties
watch boolean

run in watch mode

watch-kill-signal string

kill signal to send to the process on watch mode restarts(default: SIGTERM)

watch-path string | string[]

path to watch

watch-preserve-output boolean

preserve outputs on watch mode restart