Linux vmi2545633.contaboserver.net 6.1.0-32-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.129-1 (2025-03-06) x86_64
Apache/2.4.62 (Debian)
Server IP : 127.0.0.1 & Your IP : 127.0.0.1
Domains :
Cant Read [ /etc/named.conf ]
User : www-data
Terminal
Auto Root
Create File
Create Folder
Localroot Suggester
Backdoor Destroyer
Readme
/
usr /
share /
doc /
nodejs /
api /
Delete
Unzip
Name
Size
Permission
Date
Action
assets
[ DIR ]
drwxr-xr-x
2025-04-07 20:36
addons.html
106.29
KB
-rw-r--r--
2024-04-10 12:46
addons.json.gz
10.96
KB
-rw-r--r--
2024-04-10 12:46
addons.md
39.78
KB
-rw-r--r--
2024-04-10 12:46
all.html
7.64
MB
-rw-r--r--
2024-04-10 12:46
all.json.gz
931.76
KB
-rw-r--r--
2024-04-10 12:46
assert.html
192.08
KB
-rw-r--r--
2024-04-10 12:46
assert.json.gz
13.09
KB
-rw-r--r--
2024-04-10 12:46
assert.md
66.87
KB
-rw-r--r--
2024-04-10 12:46
async_context.html
84.69
KB
-rw-r--r--
2024-04-10 12:46
async_context.json.gz
7.15
KB
-rw-r--r--
2024-04-10 12:46
async_context.md
25.02
KB
-rw-r--r--
2024-04-10 12:46
async_hooks.html
87.84
KB
-rw-r--r--
2024-04-10 12:46
async_hooks.json.gz
9.82
KB
-rw-r--r--
2024-04-10 12:46
async_hooks.md
30.51
KB
-rw-r--r--
2024-04-10 12:46
buffer.html
479.59
KB
-rw-r--r--
2024-04-10 12:46
buffer.json.gz
28.94
KB
-rw-r--r--
2024-04-10 12:46
buffer.md
149.19
KB
-rw-r--r--
2024-04-10 12:46
child_process.html
169.7
KB
-rw-r--r--
2024-04-10 12:46
child_process.json.gz
20.87
KB
-rw-r--r--
2024-04-10 12:46
child_process.md
70.46
KB
-rw-r--r--
2024-04-10 12:46
cli.html
190.71
KB
-rw-r--r--
2024-04-10 12:46
cli.json.gz
29.53
KB
-rw-r--r--
2024-04-10 12:46
cli.md
83.21
KB
-rw-r--r--
2024-04-10 12:46
cluster.html
91.15
KB
-rw-r--r--
2024-04-10 12:46
cluster.json.gz
9.48
KB
-rw-r--r--
2024-04-10 12:46
cluster.md
28.84
KB
-rw-r--r--
2024-04-10 12:46
console.html
60
KB
-rw-r--r--
2024-04-10 12:46
console.json.gz
6.06
KB
-rw-r--r--
2024-04-10 12:46
console.md
16.5
KB
-rw-r--r--
2024-04-10 12:46
corepack.html
24.03
KB
-rw-r--r--
2024-04-10 12:46
corepack.json.gz
2.81
KB
-rw-r--r--
2024-04-10 12:46
corepack.md
5.84
KB
-rw-r--r--
2024-04-10 12:46
crypto.html
528.53
KB
-rw-r--r--
2024-04-10 12:46
crypto.json.gz
46.51
KB
-rw-r--r--
2024-04-10 12:46
crypto.md
196.46
KB
-rw-r--r--
2024-04-10 12:46
debugger.html
28.73
KB
-rw-r--r--
2024-04-10 12:46
debugger.json.gz
3.12
KB
-rw-r--r--
2024-04-10 12:46
debugger.md
7.02
KB
-rw-r--r--
2024-04-10 12:46
deprecations.html
207.23
KB
-rw-r--r--
2024-04-10 12:46
deprecations.json.gz
25.03
KB
-rw-r--r--
2024-04-10 12:46
deprecations.md
102.53
KB
-rw-r--r--
2024-04-10 12:46
dgram.html
90.78
KB
-rw-r--r--
2024-04-10 12:46
dgram.json.gz
10.2
KB
-rw-r--r--
2024-04-10 12:46
dgram.md
31.03
KB
-rw-r--r--
2024-04-10 12:46
diagnostics_channel.html
98.54
KB
-rw-r--r--
2024-04-10 12:46
diagnostics_channel.json.gz
7.72
KB
-rw-r--r--
2024-04-10 12:46
diagnostics_channel.md
31.55
KB
-rw-r--r--
2024-04-10 12:46
dns.html
131.54
KB
-rw-r--r--
2024-04-10 12:46
dns.json.gz
15.84
KB
-rw-r--r--
2024-04-10 12:46
dns.md
52.41
KB
-rw-r--r--
2024-04-10 12:46
documentation.html
26.34
KB
-rw-r--r--
2024-04-10 12:46
documentation.json.gz
2.45
KB
-rw-r--r--
2024-04-10 12:46
documentation.md
5.28
KB
-rw-r--r--
2024-04-10 12:46
domain.html
49.05
KB
-rw-r--r--
2024-04-10 12:46
domain.json.gz
6.2
KB
-rw-r--r--
2024-04-10 12:46
domain.md
15.21
KB
-rw-r--r--
2024-04-10 12:46
embedding.html
26.38
KB
-rw-r--r--
2024-04-10 12:46
embedding.json.gz
3.01
KB
-rw-r--r--
2024-04-10 12:46
embedding.md
6.65
KB
-rw-r--r--
2024-04-10 12:46
errors.html
292.27
KB
-rw-r--r--
2024-04-10 12:46
errors.json.gz
43.19
KB
-rw-r--r--
2024-04-10 12:46
errors.md
99.68
KB
-rw-r--r--
2024-04-10 12:46
esm.html
91.64
KB
-rw-r--r--
2024-04-10 12:46
esm.json.gz
15.35
KB
-rw-r--r--
2024-04-10 12:46
esm.md
42.55
KB
-rw-r--r--
2024-04-10 12:46
events.html
232.26
KB
-rw-r--r--
2024-04-10 12:46
events.json.gz
17.43
KB
-rw-r--r--
2024-04-10 12:46
events.md
67.11
KB
-rw-r--r--
2024-04-10 12:46
fs.html
643.05
KB
-rw-r--r--
2024-04-10 12:46
fs.json.gz
68.59
KB
-rw-r--r--
2024-04-10 12:46
fs.md
254.65
KB
-rw-r--r--
2024-04-10 12:46
globals.html
89.01
KB
-rw-r--r--
2024-04-10 12:46
globals.json.gz
10.65
KB
-rw-r--r--
2024-04-10 12:46
globals.md
25.62
KB
-rw-r--r--
2024-04-10 12:46
http.html
304.7
KB
-rw-r--r--
2024-04-10 12:46
http.json.gz
36.39
KB
-rw-r--r--
2024-04-10 12:46
http.md
115.14
KB
-rw-r--r--
2024-04-10 12:46
http2.html
326.42
KB
-rw-r--r--
2024-04-10 12:46
http2.json.gz
40.42
KB
-rw-r--r--
2024-04-10 12:46
http2.md
133.89
KB
-rw-r--r--
2024-04-10 12:46
https.html
58.08
KB
-rw-r--r--
2024-04-10 12:46
https.json.gz
5.82
KB
-rw-r--r--
2024-04-10 12:46
https.md
16.71
KB
-rw-r--r--
2024-04-10 12:46
index.html
13.19
KB
-rw-r--r--
2024-04-10 12:46
index.json
54
B
-rw-r--r--
2024-04-10 12:46
index.md
1.97
KB
-rw-r--r--
2024-04-10 12:46
inspector.html
52.55
KB
-rw-r--r--
2024-04-10 12:46
inspector.json.gz
4.55
KB
-rw-r--r--
2024-04-10 12:46
inspector.md
13.54
KB
-rw-r--r--
2024-04-10 12:46
intl.html
33.63
KB
-rw-r--r--
2024-04-10 12:46
intl.json.gz
4.12
KB
-rw-r--r--
2024-04-10 12:46
intl.md
11.49
KB
-rw-r--r--
2024-04-10 12:46
module.html
98.98
KB
-rw-r--r--
2024-04-10 12:46
module.json.gz
12.75
KB
-rw-r--r--
2024-04-10 12:46
module.md
35.64
KB
-rw-r--r--
2024-04-10 12:46
modules.html
81.33
KB
-rw-r--r--
2024-04-10 12:46
modules.json.gz
12.71
KB
-rw-r--r--
2024-04-10 12:46
modules.md
33.13
KB
-rw-r--r--
2024-04-10 12:46
n-api.html
414.92
KB
-rw-r--r--
2024-04-10 12:46
n-api.json.gz
53.65
KB
-rw-r--r--
2024-04-10 12:46
n-api.md
226.71
KB
-rw-r--r--
2024-04-10 12:46
net.html
153.4
KB
-rw-r--r--
2024-04-10 12:46
net.json.gz
19.3
KB
-rw-r--r--
2024-04-10 12:46
net.md
55.99
KB
-rw-r--r--
2024-04-10 12:46
os.html
72.49
KB
-rw-r--r--
2024-04-10 12:46
os.json.gz
8.91
KB
-rw-r--r--
2024-04-10 12:46
os.md
35.56
KB
-rw-r--r--
2024-04-10 12:46
packages.html
101.84
KB
-rw-r--r--
2024-04-10 12:46
packages.json.gz
15.6
KB
-rw-r--r--
2024-04-10 12:46
packages.md
47.05
KB
-rw-r--r--
2024-04-10 12:46
path.html
54.23
KB
-rw-r--r--
2024-04-10 12:46
path.json.gz
5.15
KB
-rw-r--r--
2024-04-10 12:46
path.md
15.68
KB
-rw-r--r--
2024-04-10 12:46
perf_hooks.html
155
KB
-rw-r--r--
2024-04-10 12:46
perf_hooks.json.gz
13.02
KB
-rw-r--r--
2024-04-10 12:46
perf_hooks.md
50.26
KB
-rw-r--r--
2024-04-10 12:46
permissions.html
55.66
KB
-rw-r--r--
2024-04-10 12:46
permissions.json.gz
7.74
KB
-rw-r--r--
2024-04-10 12:46
permissions.md
20.58
KB
-rw-r--r--
2024-04-10 12:46
policy.html
14.78
KB
-rw-r--r--
2024-04-10 12:46
policy.json
476
B
-rw-r--r--
2024-04-10 12:46
policy.md
222
B
-rw-r--r--
2024-04-10 12:46
process.html
298.54
KB
-rw-r--r--
2024-04-10 12:46
process.json.gz
32.32
KB
-rw-r--r--
2024-04-10 12:46
process.md
109.77
KB
-rw-r--r--
2024-04-10 12:46
punycode.html
26.81
KB
-rw-r--r--
2024-04-10 12:46
punycode.json.gz
2
KB
-rw-r--r--
2024-04-10 12:46
punycode.md
4.17
KB
-rw-r--r--
2024-04-10 12:46
querystring.html
29.11
KB
-rw-r--r--
2024-04-10 12:46
querystring.json.gz
2.65
KB
-rw-r--r--
2024-04-10 12:46
querystring.md
5.55
KB
-rw-r--r--
2024-04-10 12:46
readline.html
105.63
KB
-rw-r--r--
2024-04-10 12:46
readline.json.gz
11.63
KB
-rw-r--r--
2024-04-10 12:46
readline.md
38.86
KB
-rw-r--r--
2024-04-10 12:46
repl.html
69.37
KB
-rw-r--r--
2024-04-10 12:46
repl.json.gz
10
KB
-rw-r--r--
2024-04-10 12:46
repl.md
23.69
KB
-rw-r--r--
2024-04-10 12:46
report.html
82.12
KB
-rw-r--r--
2024-04-10 12:46
report.json.gz
6.39
KB
-rw-r--r--
2024-04-10 12:46
report.md
18.83
KB
-rw-r--r--
2024-04-10 12:46
single-executable-applications.html
43.25
KB
-rw-r--r--
2024-04-10 12:46
single-executable-applications.json.gz
5.6
KB
-rw-r--r--
2024-04-10 12:46
single-executable-applications.md
14.57
KB
-rw-r--r--
2024-04-10 12:46
stream.html
397.5
KB
-rw-r--r--
2024-04-10 12:46
stream.json.gz
51.21
KB
-rw-r--r--
2024-04-10 12:46
stream.md
146.23
KB
-rw-r--r--
2024-04-10 12:46
string_decoder.html
24.02
KB
-rw-r--r--
2024-04-10 12:46
string_decoder.json.gz
1.55
KB
-rw-r--r--
2024-04-10 12:46
string_decoder.md
2.9
KB
-rw-r--r--
2024-04-10 12:46
synopsis.html
19.55
KB
-rw-r--r--
2024-04-10 12:46
synopsis.json
2.96
KB
-rw-r--r--
2024-04-10 12:46
synopsis.md
2.11
KB
-rw-r--r--
2024-04-10 12:46
test.html
270.6
KB
-rw-r--r--
2024-04-10 12:46
test.json.gz
22.87
KB
-rw-r--r--
2024-04-10 12:46
test.md
90.96
KB
-rw-r--r--
2024-04-10 12:46
timers.html
57.88
KB
-rw-r--r--
2024-04-10 12:46
timers.json.gz
5.29
KB
-rw-r--r--
2024-04-10 12:46
timers.md
15.84
KB
-rw-r--r--
2024-04-10 12:46
tls.html
181.63
KB
-rw-r--r--
2024-04-10 12:46
tls.json.gz
32.68
KB
-rw-r--r--
2024-04-10 12:46
tls.md
89.26
KB
-rw-r--r--
2024-04-10 12:46
tracing.html
34.95
KB
-rw-r--r--
2024-04-10 12:46
tracing.json.gz
3.47
KB
-rw-r--r--
2024-04-10 12:46
tracing.md
8.52
KB
-rw-r--r--
2024-04-10 12:46
tty.html
37.52
KB
-rw-r--r--
2024-04-10 12:46
tty.json.gz
3.72
KB
-rw-r--r--
2024-04-10 12:46
tty.md
8.91
KB
-rw-r--r--
2024-04-10 12:46
url.html
152.81
KB
-rw-r--r--
2024-04-10 12:46
url.json.gz
15.87
KB
-rw-r--r--
2024-04-10 12:46
url.md
54.66
KB
-rw-r--r--
2024-04-10 12:46
util.html
290.8
KB
-rw-r--r--
2024-04-10 12:46
util.json.gz
26.7
KB
-rw-r--r--
2024-04-10 12:46
util.md
97.56
KB
-rw-r--r--
2024-04-10 12:46
v8.html
113.98
KB
-rw-r--r--
2024-04-10 12:46
v8.json.gz
12.1
KB
-rw-r--r--
2024-04-10 12:46
v8.md
35.35
KB
-rw-r--r--
2024-04-10 12:46
vm.html
161
KB
-rw-r--r--
2024-04-10 12:46
vm.json.gz
19.23
KB
-rw-r--r--
2024-04-10 12:46
vm.md
68.09
KB
-rw-r--r--
2024-04-10 12:46
wasi.html
31.38
KB
-rw-r--r--
2024-04-10 12:46
wasi.json.gz
3.48
KB
-rw-r--r--
2024-04-10 12:46
wasi.md
8.2
KB
-rw-r--r--
2024-04-10 12:46
webcrypto.html
152.64
KB
-rw-r--r--
2024-04-10 12:46
webcrypto.json.gz
9.84
KB
-rw-r--r--
2024-04-10 12:46
webcrypto.md
45.9
KB
-rw-r--r--
2024-04-10 12:46
webstreams.html
157.4
KB
-rw-r--r--
2024-04-10 12:46
webstreams.json.gz
10.44
KB
-rw-r--r--
2024-04-10 12:46
webstreams.md
39
KB
-rw-r--r--
2024-04-10 12:46
worker_threads.html
117.56
KB
-rw-r--r--
2024-04-10 12:46
worker_threads.json.gz
14.92
KB
-rw-r--r--
2024-04-10 12:46
worker_threads.md
44.67
KB
-rw-r--r--
2024-04-10 12:46
zlib.html
109.42
KB
-rw-r--r--
2024-04-10 12:46
zlib.json.gz
10.34
KB
-rw-r--r--
2024-04-10 12:46
zlib.md
35.1
KB
-rw-r--r--
2024-04-10 12:46
Save
Rename
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <meta name="nodejs.org:node-version" content="v21.7.3"> <title>About this documentation | Node.js v21.7.3 Documentation</title> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> <link rel="stylesheet" href="assets/style.css"> <link rel="stylesheet" href="assets/hljs.css"> <link rel="canonical" href="https://nodejs.org/api/documentation.html"> <script async defer src="assets/api.js" type="text/javascript"></script> <script> const storedTheme = localStorage.getItem('theme'); // Follow operating system theme preference if (storedTheme === null && window.matchMedia) { const mq = window.matchMedia('(prefers-color-scheme: dark)'); if (mq.matches) { document.documentElement.classList.add('dark-mode'); } } else if (storedTheme === 'dark') { document.documentElement.classList.add('dark-mode'); } </script> </head> <body class="alt apidoc" id="api-section-documentation"> <div id="content" class="clearfix"> <div role="navigation" id="column2" class="interior"> <div id="intro" class="interior"> <a href="/" title="Go back to the home page"> Node.js </a> </div> <ul> <li><a href="documentation.html" class="nav-documentation active">About this documentation</a></li> <li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> </ul> <hr class="line"> <ul> <li><a href="assert.html" class="nav-assert">Assertion testing</a></li> <li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> <li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> <li><a href="buffer.html" class="nav-buffer">Buffer</a></li> <li><a href="addons.html" class="nav-addons">C++ addons</a></li> <li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> <li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> <li><a href="child_process.html" class="nav-child_process">Child processes</a></li> <li><a href="cluster.html" class="nav-cluster">Cluster</a></li> <li><a href="cli.html" class="nav-cli">Command-line options</a></li> <li><a href="console.html" class="nav-console">Console</a></li> <li><a href="corepack.html" class="nav-corepack">Corepack</a></li> <li><a href="crypto.html" class="nav-crypto">Crypto</a></li> <li><a href="debugger.html" class="nav-debugger">Debugger</a></li> <li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> <li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> <li><a href="dns.html" class="nav-dns">DNS</a></li> <li><a href="domain.html" class="nav-domain">Domain</a></li> <li><a href="errors.html" class="nav-errors">Errors</a></li> <li><a href="events.html" class="nav-events">Events</a></li> <li><a href="fs.html" class="nav-fs">File system</a></li> <li><a href="globals.html" class="nav-globals">Globals</a></li> <li><a href="http.html" class="nav-http">HTTP</a></li> <li><a href="http2.html" class="nav-http2">HTTP/2</a></li> <li><a href="https.html" class="nav-https">HTTPS</a></li> <li><a href="inspector.html" class="nav-inspector">Inspector</a></li> <li><a href="intl.html" class="nav-intl">Internationalization</a></li> <li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> <li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> <li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> <li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> <li><a href="net.html" class="nav-net">Net</a></li> <li><a href="os.html" class="nav-os">OS</a></li> <li><a href="path.html" class="nav-path">Path</a></li> <li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> <li><a href="permissions.html" class="nav-permissions">Permissions</a></li> <li><a href="process.html" class="nav-process">Process</a></li> <li><a href="punycode.html" class="nav-punycode">Punycode</a></li> <li><a href="querystring.html" class="nav-querystring">Query strings</a></li> <li><a href="readline.html" class="nav-readline">Readline</a></li> <li><a href="repl.html" class="nav-repl">REPL</a></li> <li><a href="report.html" class="nav-report">Report</a></li> <li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> <li><a href="stream.html" class="nav-stream">Stream</a></li> <li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> <li><a href="test.html" class="nav-test">Test runner</a></li> <li><a href="timers.html" class="nav-timers">Timers</a></li> <li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> <li><a href="tracing.html" class="nav-tracing">Trace events</a></li> <li><a href="tty.html" class="nav-tty">TTY</a></li> <li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> <li><a href="url.html" class="nav-url">URL</a></li> <li><a href="util.html" class="nav-util">Utilities</a></li> <li><a href="v8.html" class="nav-v8">V8</a></li> <li><a href="vm.html" class="nav-vm">VM</a></li> <li><a href="wasi.html" class="nav-wasi">WASI</a></li> <li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> <li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> <li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> <li><a href="zlib.html" class="nav-zlib">Zlib</a></li> </ul> <hr class="line"> <ul> <li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> </ul> </div> <div id="column1" data-id="documentation" class="interior"> <header class="header"> <div class="header-container"> <h1>Node.js v21.7.3 documentation</h1> <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> <path fill="none" d="M0 0h24v24H0z" /> <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> </svg> <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> <path d="M0 0h24v24H0z" fill="none" /> <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> </svg> </button> </div> <div id="gtoc"> <ul> <li class="pinned-header">Node.js v21.7.3</li> <li class="picker-header"> <a href="#"> <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> Table of contents </a> <div class="picker"><div class="toc"><ul> <li><a href="#about-this-documentation">About this documentation</a> <ul> <li><a href="#contributing">Contributing</a></li> <li><a href="#stability-index">Stability index</a></li> <li><a href="#stability-overview">Stability overview</a></li> <li><a href="#json-output">JSON output</a></li> <li><a href="#system-calls-and-man-pages">System calls and man pages</a></li> </ul> </li> </ul></div></div> </li> <li class="picker-header"> <a href="#"> <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> Index </a> <div class="picker"><ul> <li><a href="documentation.html" class="nav-documentation active">About this documentation</a></li> <li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> <li> <a href="index.html">Index</a> </li> </ul> <hr class="line"> <ul> <li><a href="assert.html" class="nav-assert">Assertion testing</a></li> <li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> <li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> <li><a href="buffer.html" class="nav-buffer">Buffer</a></li> <li><a href="addons.html" class="nav-addons">C++ addons</a></li> <li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> <li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> <li><a href="child_process.html" class="nav-child_process">Child processes</a></li> <li><a href="cluster.html" class="nav-cluster">Cluster</a></li> <li><a href="cli.html" class="nav-cli">Command-line options</a></li> <li><a href="console.html" class="nav-console">Console</a></li> <li><a href="corepack.html" class="nav-corepack">Corepack</a></li> <li><a href="crypto.html" class="nav-crypto">Crypto</a></li> <li><a href="debugger.html" class="nav-debugger">Debugger</a></li> <li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> <li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> <li><a href="dns.html" class="nav-dns">DNS</a></li> <li><a href="domain.html" class="nav-domain">Domain</a></li> <li><a href="errors.html" class="nav-errors">Errors</a></li> <li><a href="events.html" class="nav-events">Events</a></li> <li><a href="fs.html" class="nav-fs">File system</a></li> <li><a href="globals.html" class="nav-globals">Globals</a></li> <li><a href="http.html" class="nav-http">HTTP</a></li> <li><a href="http2.html" class="nav-http2">HTTP/2</a></li> <li><a href="https.html" class="nav-https">HTTPS</a></li> <li><a href="inspector.html" class="nav-inspector">Inspector</a></li> <li><a href="intl.html" class="nav-intl">Internationalization</a></li> <li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> <li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> <li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> <li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> <li><a href="net.html" class="nav-net">Net</a></li> <li><a href="os.html" class="nav-os">OS</a></li> <li><a href="path.html" class="nav-path">Path</a></li> <li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> <li><a href="permissions.html" class="nav-permissions">Permissions</a></li> <li><a href="process.html" class="nav-process">Process</a></li> <li><a href="punycode.html" class="nav-punycode">Punycode</a></li> <li><a href="querystring.html" class="nav-querystring">Query strings</a></li> <li><a href="readline.html" class="nav-readline">Readline</a></li> <li><a href="repl.html" class="nav-repl">REPL</a></li> <li><a href="report.html" class="nav-report">Report</a></li> <li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> <li><a href="stream.html" class="nav-stream">Stream</a></li> <li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> <li><a href="test.html" class="nav-test">Test runner</a></li> <li><a href="timers.html" class="nav-timers">Timers</a></li> <li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> <li><a href="tracing.html" class="nav-tracing">Trace events</a></li> <li><a href="tty.html" class="nav-tty">TTY</a></li> <li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> <li><a href="url.html" class="nav-url">URL</a></li> <li><a href="util.html" class="nav-util">Utilities</a></li> <li><a href="v8.html" class="nav-v8">V8</a></li> <li><a href="vm.html" class="nav-vm">VM</a></li> <li><a href="wasi.html" class="nav-wasi">WASI</a></li> <li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> <li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> <li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> <li><a href="zlib.html" class="nav-zlib">Zlib</a></li> </ul> <hr class="line"> <ul> <li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> </ul></div> </li> <li class="picker-header"> <a href="#"> <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> Other versions </a> <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/documentation.html">21.x</a></li> <li><a href="https://nodejs.org/docs/latest-v20.x/api/documentation.html">20.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v19.x/api/documentation.html">19.x</a></li> <li><a href="https://nodejs.org/docs/latest-v18.x/api/documentation.html">18.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v17.x/api/documentation.html">17.x</a></li> <li><a href="https://nodejs.org/docs/latest-v16.x/api/documentation.html">16.x</a></li> <li><a href="https://nodejs.org/docs/latest-v15.x/api/documentation.html">15.x</a></li> <li><a href="https://nodejs.org/docs/latest-v14.x/api/documentation.html">14.x</a></li> <li><a href="https://nodejs.org/docs/latest-v13.x/api/documentation.html">13.x</a></li> <li><a href="https://nodejs.org/docs/latest-v12.x/api/documentation.html">12.x</a></li> <li><a href="https://nodejs.org/docs/latest-v11.x/api/documentation.html">11.x</a></li> <li><a href="https://nodejs.org/docs/latest-v10.x/api/documentation.html">10.x</a></li> <li><a href="https://nodejs.org/docs/latest-v9.x/api/documentation.html">9.x</a></li> <li><a href="https://nodejs.org/docs/latest-v8.x/api/documentation.html">8.x</a></li> <li><a href="https://nodejs.org/docs/latest-v7.x/api/documentation.html">7.x</a></li> <li><a href="https://nodejs.org/docs/latest-v6.x/api/documentation.html">6.x</a></li> <li><a href="https://nodejs.org/docs/latest-v5.x/api/documentation.html">5.x</a></li> <li><a href="https://nodejs.org/docs/latest-v4.x/api/documentation.html">4.x</a></li> <li><a href="https://nodejs.org/docs/latest-v0.12.x/api/documentation.html">0.12.x</a></li> <li><a href="https://nodejs.org/docs/latest-v0.10.x/api/documentation.html">0.10.x</a></li></ol></div> </li> <li class="picker-header"> <a href="#"> <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> Options </a> <div class="picker"> <ul> <li> <a href="all.html">View on single page</a> </li> <li> <a href="documentation.json">View as JSON</a> </li> <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/documentation.md">Edit on GitHub</a></li> </ul> </div> </li> </ul> </div> <hr> </header> <details role="navigation" id="toc" open><summary>Table of contents</summary><ul> <li><a href="#about-this-documentation">About this documentation</a> <ul> <li><a href="#contributing">Contributing</a></li> <li><a href="#stability-index">Stability index</a></li> <li><a href="#stability-overview">Stability overview</a></li> <li><a href="#json-output">JSON output</a></li> <li><a href="#system-calls-and-man-pages">System calls and man pages</a></li> </ul> </li> </ul></details> <div role="main" id="apicontent"> <h2>About this documentation<span><a class="mark" href="#about-this-documentation" id="about-this-documentation">#</a></span><a aria-hidden="true" class="legacy" id="documentation_about_this_documentation"></a></h2> <p>Welcome to the official API reference documentation for Node.js!</p> <p>Node.js is a JavaScript runtime built on the <a href="https://v8.dev/">V8 JavaScript engine</a>.</p> <section><h3>Contributing<span><a class="mark" href="#contributing" id="contributing">#</a></span><a aria-hidden="true" class="legacy" id="documentation_contributing"></a></h3> <p>Report errors in this documentation in <a href="https://github.com/nodejs/node/issues/new">the issue tracker</a>. See <a href="https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md">the contributing guide</a> for directions on how to submit pull requests.</p> </section><section><h3>Stability index<span><a class="mark" href="#stability-index" id="stability-index">#</a></span><a aria-hidden="true" class="legacy" id="documentation_stability_index"></a></h3> <p>Throughout the documentation are indications of a section's stability. Some APIs are so proven and so relied upon that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous.</p> <p>The stability indices are as follows:</p> <p></p><div class="api_stability api_stability_0">Stability: 0 - Deprecated. The feature may emit warnings. Backward compatibility is not guaranteed.</div><p></p> <!-- separator --> <p></p><div class="api_stability api_stability_1">Stability: 1 - Experimental. The feature is not subject to <a href="https://semver.org/">semantic versioning</a> rules. Non-backward compatible changes or removal may occur in any future release. Use of the feature is not recommended in production environments.<p>Experimental features are subdivided into stages:</p><ul> <li>1.0 - Early development. Experimental features at this stage are unfinished and subject to substantial change.</li> <li>1.1 - Active development. Experimental features at this stage are nearing minimum viability.</li> <li>1.2 - Release candidate. Experimental features at this stage are hopefully ready to become stable. No further breaking changes are anticipated but may still occur in response to user feedback. We encourage user testing and feedback so that we can know that this feature is ready to be marked as stable.</li> </ul></div><p></p> <!-- separator --> <p></p><div class="api_stability api_stability_2">Stability: 2 - Stable. Compatibility with the npm ecosystem is a high priority.</div><p></p> <!-- separator --> <p></p><div class="api_stability api_stability_3">Stability: 3 - Legacy. Although this feature is unlikely to be removed and is still covered by semantic versioning guarantees, it is no longer actively maintained, and other alternatives are available.</div><p></p> <p>Features are marked as legacy rather than being deprecated if their use does no harm, and they are widely relied upon within the npm ecosystem. Bugs found in legacy features are unlikely to be fixed.</p> <p>Use caution when making use of Experimental features, particularly when authoring libraries. Users may not be aware that experimental features are being used. Bugs or behavior changes may surprise users when Experimental API modifications occur. To avoid surprises, use of an Experimental feature may need a command-line flag. Experimental features may also emit a <a href="process.html#event-warning">warning</a>.</p> </section><section><h3>Stability overview<span><a class="mark" href="#stability-overview" id="stability-overview">#</a></span><a aria-hidden="true" class="legacy" id="documentation_stability_overview"></a></h3> <!-- STABILITY_OVERVIEW_SLOT_BEGIN --><table><thead><tr><th>API</th><th>Stability</th></tr></thead><tbody><tr><td class="module_stability"><a href="assert.html">Assert</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="async_hooks.html">Async hooks</a></td><td class="api_stability api_stability_1">(1) Experimental</td></tr><tr><td class="module_stability"><a href="async_context.html">Asynchronous context tracking</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="buffer.html">Buffer</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="child_process.html">Child process</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="cluster.html">Cluster</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="console.html">Console</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="crypto.html">Crypto</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="diagnostics_channel.html">Diagnostics Channel</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="dns.html">DNS</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="domain.html">Domain</a></td><td class="api_stability api_stability_0">(0) Deprecated</td></tr><tr><td class="module_stability"><a href="fs.html">File system</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="http.html">HTTP</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="http2.html">HTTP/2</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="https.html">HTTPS</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="inspector.html">Inspector</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="module.html">Modules: <code>node:module</code> API</a></td><td class="api_stability api_stability_1">(1) .2 - Release candidate</td></tr><tr><td class="module_stability"><a href="modules.html">Modules: CommonJS modules</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="os.html">OS</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="path.html">Path</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="perf_hooks.html">Performance measurement APIs</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="punycode.html">Punycode</a></td><td class="api_stability api_stability_0">(0) Deprecated</td></tr><tr><td class="module_stability"><a href="querystring.html">Query string</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="readline.html">Readline</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="repl.html">REPL</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="single-executable-applications.html">Single executable applications</a></td><td class="api_stability api_stability_1">(1) .1 - Active development</td></tr><tr><td class="module_stability"><a href="stream.html">Stream</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="string_decoder.html">String decoder</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="test.html">Test runner</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="timers.html">Timers</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="tls.html">TLS (SSL)</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="tracing.html">Trace events</a></td><td class="api_stability api_stability_1">(1) Experimental</td></tr><tr><td class="module_stability"><a href="tty.html">TTY</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="dgram.html">UDP/datagram sockets</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="url.html">URL</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="util.html">Util</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="vm.html">VM (executing JavaScript)</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="webcrypto.html">Web Crypto API</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="webstreams.html">Web Streams API</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="wasi.html">WebAssembly System Interface (WASI)</a></td><td class="api_stability api_stability_1">(1) Experimental</td></tr><tr><td class="module_stability"><a href="worker_threads.html">Worker threads</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr><tr><td class="module_stability"><a href="zlib.html">Zlib</a></td><td class="api_stability api_stability_2">(2) Stable</td></tr></tbody></table><!-- STABILITY_OVERVIEW_SLOT_END --> </section><section><h3>JSON output<span><a class="mark" href="#json-output" id="json-output">#</a></span><a aria-hidden="true" class="legacy" id="documentation_json_output"></a></h3> <div class="api_metadata"> <span>Added in: v0.6.12</span> </div> <p>Every <code>.html</code> document has a corresponding <code>.json</code> document. This is for IDEs and other utilities that consume the documentation.</p> </section><section><h3>System calls and man pages<span><a class="mark" href="#system-calls-and-man-pages" id="system-calls-and-man-pages">#</a></span><a aria-hidden="true" class="legacy" id="documentation_system_calls_and_man_pages"></a></h3> <p>Node.js functions which wrap a system call will document that. The docs link to the corresponding man pages which describe how the system call works.</p> <p>Most Unix system calls have Windows analogues. Still, behavior differences may be unavoidable.</p></section> <!-- API END --> </div> </div> </div> </body> </html>