Skip to content

node

node documentation

Node

Bases: Tool[_R]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Node[Argv]

argv property

argv: Node[Argv]

__call__

__call__(*args: str | PathLike[str], abort_on_uncaught_exception: Flag = ..., allow_addons: Flag = ..., allow_child_process: Flag = ..., allow_fs_read: Flag = ..., allow_fs_write: Flag = ..., allow_inspector: Flag = ..., allow_openssl_store: Flag = ..., allow_wasi: Flag = ..., allow_worker: Flag = ..., build_snapshot: Flag = ..., build_snapshot_config: Flag = ..., check: Flag = ..., completion_bash: Flag = ..., conditions: Flag = ..., cpu_prof: Flag = ..., cpu_prof_dir: Flag = ..., cpu_prof_interval: Flag = ..., cpu_prof_name: Flag = ..., debug_port: Value = ..., diagnostic_dir: Flag = ..., disable_proto: Flag = ..., disable_sigusr1: Flag = ..., disable_warning: Flag = ..., disable_wasm_trap_handler: Value = ..., disallow_code_generation_from_strings: Flag = ..., dns_result_order: Flag = ..., enable_etw_stack_walking: Flag = ..., enable_fips: Flag = ..., enable_network_family_autoselection: Flag = ..., enable_source_maps: Flag = ..., entry_url: Flag = ..., env_file: Flag = ..., env_file_if_exists: Flag = ..., eval: Flag = ..., experimental_addon_modules: Flag = ..., experimental_default_config_file: Flag = ..., experimental_eventsource: Flag = ..., experimental_import_meta_resolve: Flag = ..., experimental_import_text: Flag = ..., experimental_inspector_network_resource: Flag = ..., experimental_network_inspection: Flag = ..., experimental_package_map: Flag = ..., experimental_print_required_tla: Flag = ..., experimental_sea_config: Flag = ..., experimental_storage_inspection: Flag = ..., experimental_stream_iter: Flag = ..., experimental_strip_types: Flag = ..., experimental_test_coverage: Flag = ..., experimental_test_isolation: Flag = ..., experimental_test_module_mocks: Flag = ..., experimental_test_tag_filter: Flag = ..., experimental_transform_types: Flag = ..., experimental_vm_modules: Flag = ..., experimental_webstorage: Flag = ..., experimental_worker_inspection: Flag = ..., expose_gc: Flag = ..., force_context_aware: Flag = ..., force_fips: Flag = ..., force_node_api_uncaught_exceptions_policy: Flag = ..., frozen_intrinsics: Flag = ..., heap_prof: Flag = ..., heap_prof_dir: Flag = ..., heap_prof_interval: Flag = ..., heap_prof_name: Flag = ..., heapsnapshot_near_heap_limit: Flag = ..., heapsnapshot_signal: Flag = ..., icu_data_dir: Flag = ..., import_: Flag = ..., input_type: Flag = ..., insecure_http_parser: Flag = ..., inspect: ValuedFlag = ..., inspect_brk: ValuedFlag = ..., inspect_publish_uid: Flag = ..., inspect_wait: ValuedFlag = ..., interactive: Flag = ..., interpreted_frames_native_stack: Flag = ..., jitless: Flag = ..., loader: Flag = ..., localstorage_file: Flag = ..., max_http_header_size: Flag = ..., max_old_space_size_percentage: Flag = ..., network_family_autoselection_attempt_timeout: Flag = ..., no_addons: Flag = ..., no_async_context_frame: Flag = ..., no_deprecation: Flag = ..., no_experimental_detect_module: Flag = ..., no_experimental_global_navigator: Flag = ..., no_experimental_repl_await: Flag = ..., no_experimental_require_module: Flag = ..., no_experimental_sqlite: Flag = ..., no_experimental_websocket: Value = ..., no_extra_info_on_fatal_exception: Flag = ..., no_force_async_hooks_checks: Flag = ..., no_global_search_paths: Flag = ..., no_require_module: Flag = ..., no_warnings: Flag = ..., node_memory_debug: Flag = ..., openssl_config: Flag = ..., openssl_legacy_provider: Flag = ..., openssl_shared_config: Flag = ..., pending_deprecation: Flag = ..., permission: Flag = ..., permission_audit: Flag = ..., preserve_symlinks: Flag = ..., preserve_symlinks_main: Flag = ..., print: Value = ..., prof: Flag = ..., prof_process: Flag = ..., redirect_warnings: Flag = ..., report_compact: Flag = ..., report_directory: Flag = ..., report_exclude_env: Flag = ..., report_exclude_network: Flag = ..., report_filename: Flag = ..., report_on_fatalerror: Flag = ..., report_on_signal: Flag = ..., report_signal: Flag = ..., report_uncaught_exception: Value = ..., require: Flag = ..., run: Flag = ..., secure_heap: Flag = ..., secure_heap_min: Flag = ..., snapshot_blob: Flag = ..., test: Flag = ..., test_concurrency: Flag = ..., test_coverage_branches: Flag = ..., test_coverage_exclude: Flag = ..., test_coverage_functions: Flag = ..., test_coverage_include: Flag = ..., test_coverage_lines: Flag = ..., test_force_exit: Flag = ..., test_global_setup: Flag = ..., test_name_pattern: Flag = ..., test_only: Flag = ..., test_random_seed: Flag = ..., test_randomize: Flag = ..., test_reporter: Flag = ..., test_reporter_destination: Flag = ..., test_rerun_failures: Flag = ..., test_shard: Flag = ..., test_skip_pattern: Flag = ..., test_timeout: Flag = ..., test_update_snapshots: Flag = ..., throw_deprecation: Flag = ..., title: Flag = ..., tls_cipher_list: Flag = ..., tls_keylog: Flag = ..., tls_max_v1_2: Flag = ..., tls_max_v1_3: Flag = ..., tls_min_v1_0: Flag = ..., tls_min_v1_1: Flag = ..., tls_min_v1_2: Flag = ..., tls_min_v1_3: Flag = ..., trace_deprecation: Flag = ..., trace_env: Flag = ..., trace_env_js_stack: Flag = ..., trace_env_native_stack: Flag = ..., trace_event_categories: Flag = ..., trace_event_file_pattern: Flag = ..., trace_exit: Flag = ..., trace_promises: Flag = ..., trace_require_module: Flag = ..., trace_sigint: Flag = ..., trace_sync_io: Flag = ..., trace_tls: Flag = ..., trace_uncaught: Flag = ..., trace_warnings: Flag = ..., track_heap_objects: Flag = ..., unhandled_rejections: Flag = ..., use_bundled_ca: Flag = ..., use_env_proxy: Flag = ..., use_largepages: Flag = ..., use_openssl_ca: Flag = ..., use_system_ca: Flag = ..., v8_options: Flag = ..., v8_pool_size: Flag = ..., watch: Flag = ..., watch_kill_signal: Flag = ..., watch_path: Flag = ..., watch_preserve_output: Flag = ..., zero_fill_buffers: Flag = ..., **flags: Any) -> _R

Run this verb.

Parameters:

Name Type Description Default
abort_on_uncaught_exception Flag

aborting instead of exiting causes a core file to be generated for analysis.

...
allow_addons Flag

allow use of addons when any permissions are set.

...
allow_child_process Flag

allow use of child process when any permissions are set.

...
allow_fs_read Flag

allow permissions to read the filesystem.

...
allow_fs_write Flag

allow permissions to write in the filesystem.

...
allow_inspector Flag

allow use of inspector when any permissions are set.

...
allow_openssl_store Flag

allow use of OpenSSL STORE loaders when any permissions are set.

...
allow_wasi Flag

allow wasi when any permissions are set.

...
allow_worker Flag

allow worker threads when any permissions are set.

...
build_snapshot Flag

Generate a snapshot blob when the process exits.

...
build_snapshot_config Flag

process exits using aJSON configuration in the specified path.

...
check Flag

syntax check script without executing.

...
completion_bash Flag

print source-able bash completion script.

...
conditions Flag

additional user conditions for conditional exports and imports.

...
cpu_prof Flag

Start the V8 CPU profiler on start up, and write the CPU profile to disk before exit.

...
cpu_prof_dir Flag

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

...
cpu_prof_interval Flag

specified sampling interval in microseconds for the V8 CPU profile generated with --cpu-prof.

...
cpu_prof_name Flag

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

...
debug_port Value

set host:port for inspector.

...
diagnostic_dir Flag

set dir for all output files.

...
disable_proto Flag

disable Object.prototype.proto.

...
disable_sigusr1 Flag

Disable inspector thread to be listening for SIGUSR1 signal.

...
disable_warning Flag

silence specific process warnings.

...
disable_wasm_trap_handler Value

bound checks.

...
disallow_code_generation_from_strings Flag

disallow eval and friends.

...
dns_result_order Flag

set default value of verbatim in dns.lookup.

...
enable_etw_stack_walking Flag

provides heap data to ETW Windows native tracing.

...
enable_fips Flag

enable FIPS crypto at startup.

...
enable_network_family_autoselection Flag

Disable network address family autodetection algorithm.

...
enable_source_maps Flag

Source Map V3 support for stack traces.

...
entry_url Flag

Treat the entrypoint as a URL.

...
env_file Flag

set environment variables from supplied file.

...
env_file_if_exists Flag

set environment variables from supplied file.

...
eval Flag

evaluate script.

...
experimental_addon_modules Flag

experimental import support for addons (currently set).

...
experimental_default_config_file Flag

set config file path.

...
experimental_eventsource Flag

experimental EventSource API.

...
experimental_import_meta_resolve Flag

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

...
experimental_import_text Flag

experimental support for importing source as text with import attributes.

...
experimental_inspector_network_resource Flag

experimental load network resources via the inspector.

...
experimental_network_inspection Flag

experimental network inspection support.

...
experimental_package_map Flag

use the specified file for package map resolution.

...
experimental_print_required_tla Flag

Print pending top-level await.

...
experimental_sea_config Flag

Generate a blob that can be embedded into the single executable application.

...
experimental_storage_inspection Flag

experimental storage inspection support.

...
experimental_stream_iter Flag

experimental iterable streams API (node:stream/iter).

...
experimental_strip_types Flag

Type-stripping for TypeScript files.

...
experimental_test_coverage Flag

enable code coverage in the test runner.

...
experimental_test_isolation Flag

configures the type of test isolation used in the test runner.

...
experimental_test_module_mocks Flag

enable module mocking in the test runner.

...
experimental_test_tag_filter Flag

run tests matching the given tag filter expression.

...
experimental_transform_types Flag

enable transformation of TypeScript-onlysyntax into JavaScript code.

...
experimental_vm_modules Flag

experimental ES Module support in vm module.

...
experimental_webstorage Flag

experimental Web Storage API.

...
experimental_worker_inspection Flag

experimental worker inspection support.

...
expose_gc Flag

expose gc extension.

...
force_context_aware Flag

disable loading non-context-aware addons.

...
force_fips Flag

force FIPS crypto (cannot be disabled).

...
force_node_api_uncaught_exceptions_policy Flag

enforces 'uncaughtException' event on Node API asynchronous callbacks.

...
frozen_intrinsics Flag

experimental frozen intrinsics support.

...
heap_prof Flag

Start the V8 heap profiler on start up, and write the heap profile to disk before exit.

...
heap_prof_dir Flag

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

...
heap_prof_interval Flag

specified sampling interval in bytes for the V8 heap profile generated with --heap-prof.

...
heap_prof_name Flag

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

...
heapsnapshot_near_heap_limit Flag

Generate heap snapshots whenever V8 is approaching the heap limit.

...
heapsnapshot_signal Flag

Generate heap snapshot on specified signal.

...
icu_data_dir Flag

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

...
import_ Flag

ES module to preload (option can be repeated).

...
input_type Flag

set module type for string input.

...
insecure_http_parser Flag

use an insecure HTTP parser that accepts invalid HTTP headers.

...
inspect ValuedFlag

activate inspector on host:port. Value optional: True for the bare flag, or pass one. Defaults to 127.0.0.1:9229.

...
inspect_brk ValuedFlag

break at start of user script. Value optional: True for the bare flag, or pass one.

...
inspect_publish_uid Flag

comma separated list of destinations for inspector uid.

...
inspect_wait ValuedFlag

activate inspector on host:port and wait for debugger to be attached. Value optional: True for the bare flag, or pass one.

...
interactive Flag

always enter the REPL even if stdin does not appear to be a terminal.

...
interpreted_frames_native_stack Flag

help system profilers to translate JavaScript interpreted frames.

...
jitless Flag

disable runtime allocation of executable memory.

...
loader Flag

use the specified module as a custom loader.

...
localstorage_file Flag

file used to persist localStorage data.

...
max_http_header_size Flag

set the maximum size of HTTP headers ).

...
max_old_space_size_percentage Flag

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

...
network_family_autoselection_attempt_timeout Flag

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

...
no_addons Flag

disable loading native addons.

...
no_async_context_frame Flag

Improve AsyncLocalStorage performance with AsyncContextFrame.

...
no_deprecation Flag

silence deprecation warnings.

...
no_experimental_detect_module Flag

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

...
no_experimental_global_navigator Flag

expose experimental Navigator API on the global scope.

...
no_experimental_repl_await Flag

experimental await keyword support in REPL.

...
no_experimental_require_module Flag

Legacy alias for --require-module.

...
no_experimental_sqlite Flag

experimental node:sqlite module.

...
no_extra_info_on_fatal_exception Flag

hide extra information on fatal exception that causes exit.

...
no_force_async_hooks_checks Flag

disable checks for async_hooks.

...
no_global_search_paths Flag

disable global module search paths.

...
no_require_module Flag

Allow loading synchronous ES Modules in require().

...
no_warnings Flag

silence all process warnings.

...
node_memory_debug Flag

Run with extra debug checks for memory leaks in Node.js itself.

...
openssl_config Flag

load OpenSSL configuration from the specified file (overrides OPENSSL_CONF).

...
openssl_legacy_provider Flag

enable OpenSSL 3.0 legacy provider.

...
openssl_shared_config Flag

enable OpenSSL shared configuration.

...
pending_deprecation Flag

emit pending deprecation warnings.

...
permission Flag

enable the permission system.

...
permission_audit Flag

enable audit only for the permission system.

...
preserve_symlinks Flag

preserve symbolic links when resolving.

...
preserve_symlinks_main Flag

preserve symbolic links when resolving the main module.

...
print Value

evaluate script and print result. May be repeated: a list emits the flag once per item.

...
prof Flag

Generate V8 profiler output.

...
prof_process Flag

process V8 profiler output generated using --prof.

...
redirect_warnings Flag

write warnings to file instead of stderr.

...
report_compact Flag

output compact single-line JSON.

...
report_directory Flag

define custom report pathname.

...
report_exclude_env Flag

Exclude environment variables when generating report.

...
report_exclude_network Flag

exclude network interface diagnostics.

...
report_filename Flag

define custom report file name.

...
report_on_fatalerror Flag

generate diagnostic report on fatal (internal) errors.

...
report_on_signal Flag

generate diagnostic report upon receiving signals.

...
report_signal Flag

causes diagnostic report to be produced on provided signal, unsupported in Windows.

...
report_uncaught_exception Value

exceptions.

...
require Flag

CommonJS module to preload (option can be repeated).

...
run Flag

Run a script specified in package.json.

...
secure_heap Flag

total size of the OpenSSL secure heap.

...
secure_heap_min Flag

minimum allocation size from the OpenSSL secure heap.

...
snapshot_blob Flag

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

...
test Flag

launch test runner on startup.

...
test_concurrency Flag

specify test runner concurrency.

...
test_coverage_branches Flag

the branch coverage minimum threshold.

...
test_coverage_exclude Flag

match this glob pattern.

...
test_coverage_functions Flag

the function coverage minimum threshold.

...
test_coverage_include Flag

match this glob pattern.

...
test_coverage_lines Flag

the line coverage minimum threshold.

...
test_force_exit Flag

force test runner to exit upon completion.

...
test_global_setup Flag

specifies the path to the global setup file.

...
test_name_pattern Flag

run tests whose name matches this regular expression.

...
test_only Flag

run tests with 'only' option set.

...
test_random_seed Flag

seed used to randomize test execution order.

...
test_randomize Flag

run tests in a random order.

...
test_reporter Flag

report test output using the given reporter.

...
test_reporter_destination Flag

report given reporter to the given destination.

...
test_rerun_failures Flag

specifies the path to the rerun state file.

...
test_shard Flag

run test at specific shard.

...
test_skip_pattern Flag

run tests whose name do not match this regular expression.

...
test_timeout Flag

specify test runner timeout.

...
test_update_snapshots Flag

regenerate test snapshots.

...
throw_deprecation Flag

throw an exception on deprecations.

...
title Flag

the process title to use on startup.

...
tls_cipher_list Flag

use an alternative default TLS cipher list.

...
tls_keylog Flag

log TLS decryption keys to named file for traffic analysis.

...
tls_max_v1_2 Flag

set default TLS maximum to TLSv1.2.

...
tls_max_v1_3 Flag

set default TLS maximum to TLSv1.3.

...
tls_min_v1_0 Flag

set default TLS minimum to TLSv1.0.

...
tls_min_v1_1 Flag

set default TLS minimum to TLSv1.1.

...
tls_min_v1_2 Flag

set default TLS minimum to TLSv1.2.

...
tls_min_v1_3 Flag

set default TLS minimum to TLSv1.3.

...
trace_deprecation Flag

show stack traces on deprecations.

...
trace_env Flag

Print accesses to the environment variables.

...
trace_env_js_stack Flag

Print accesses to the environment variables and the JavaScript stack trace.

...
trace_env_native_stack Flag

Print accesses to the environment variables and the native stack trace.

...
trace_event_categories Flag

comma separated list of trace event categories to record.

...
trace_event_file_pattern Flag

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

...
trace_exit Flag

show stack trace when an environment exits.

...
trace_promises Flag

show stack traces on promise initialization and resolution.

...
trace_require_module Flag

Print access to require(esm).

...
trace_sigint Flag

enable printing JavaScript stacktrace on SIGINT.

...
trace_sync_io Flag

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

...
trace_tls Flag

prints TLS packet trace information to stderr.

...
trace_uncaught Flag

show stack traces for the throw behind uncaught exceptions.

...
trace_warnings Flag

show stack traces on process warnings.

...
track_heap_objects Flag

track heap object allocations for heap snapshots.

...
unhandled_rejections Flag

define unhandled rejections behavior.

...
use_bundled_ca Flag

use bundled CA store (default).

...
use_env_proxy Flag

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

...
use_largepages Flag

Map the Node.js static code to large pages.

...
use_openssl_ca Flag

use OpenSSL's default CA store.

...
use_system_ca Flag

use system's CA store.

...
v8_options Flag

print V8 command line options.

...
v8_pool_size Flag

set V8's thread pool size.

...
watch Flag

run in watch mode.

...
watch_kill_signal Flag

kill signal to send to the process on watch mode restarts.

...
watch_path Flag

path to watch.

...
watch_preserve_output Flag

preserve outputs on watch mode restart.

...
zero_fill_buffers Flag

automatically zero-fill all newly allocated Buffer and SlowBuffer instances.

...