• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <meta charset="utf-8">
5  <meta name="viewport" content="width=device-width">
6  <meta name="nodejs.org:node-version" content="v14.21.2">
7  <title>Index | Node.js v14.21.2 Documentation</title>
8  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
9  <link rel="stylesheet" href="assets/style.css">
10  <link rel="stylesheet" href="assets/hljs.css">
11  <link rel="canonical" href="https://nodejs.org/api/index.html">
12</head>
13<body class="alt apidoc" id="api-section-index">
14  <div id="content" class="clearfix">
15    <div id="column2" class="interior">
16      <div id="intro" class="interior">
17        <a href="/" title="Go back to the home page">
18          Node.js
19        </a>
20      </div>
21      <ul>
22<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
23<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>
24</ul>
25<hr class="line">
26<ul>
27<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
28<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
29<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
30<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
31<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
32<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li>
33<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
34<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
35<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
36<li><a href="console.html" class="nav-console">Console</a></li>
37<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
38<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
39<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
40<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
41<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
42<li><a href="dns.html" class="nav-dns">DNS</a></li>
43<li><a href="domain.html" class="nav-domain">Domain</a></li>
44<li><a href="errors.html" class="nav-errors">Errors</a></li>
45<li><a href="events.html" class="nav-events">Events</a></li>
46<li><a href="fs.html" class="nav-fs">File system</a></li>
47<li><a href="globals.html" class="nav-globals">Globals</a></li>
48<li><a href="http.html" class="nav-http">HTTP</a></li>
49<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
50<li><a href="https.html" class="nav-https">HTTPS</a></li>
51<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
52<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
53<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
54<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
55<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li>
56<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
57<li><a href="net.html" class="nav-net">Net</a></li>
58<li><a href="os.html" class="nav-os">OS</a></li>
59<li><a href="path.html" class="nav-path">Path</a></li>
60<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
61<li><a href="policy.html" class="nav-policy">Policies</a></li>
62<li><a href="process.html" class="nav-process">Process</a></li>
63<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
64<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
65<li><a href="readline.html" class="nav-readline">Readline</a></li>
66<li><a href="repl.html" class="nav-repl">REPL</a></li>
67<li><a href="report.html" class="nav-report">Report</a></li>
68<li><a href="stream.html" class="nav-stream">Stream</a></li>
69<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
70<li><a href="timers.html" class="nav-timers">Timers</a></li>
71<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
72<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
73<li><a href="tty.html" class="nav-tty">TTY</a></li>
74<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
75<li><a href="url.html" class="nav-url">URL</a></li>
76<li><a href="util.html" class="nav-util">Utilities</a></li>
77<li><a href="v8.html" class="nav-v8">V8</a></li>
78<li><a href="vm.html" class="nav-vm">VM</a></li>
79<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
80<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
81<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
82</ul>
83<hr class="line">
84<ul>
85<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
86</ul>
87    </div>
88
89    <div id="column1" data-id="index" class="interior">
90      <header>
91        <div class="header-container">
92          <h1>Node.js v14.21.2 documentation</h1>
93          <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
94            <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
95              <path fill="none" d="M0 0h24v24H0z" />
96              <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"/>
97              <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"/>
98            </svg>
99            <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
100              <path d="M0 0h24v24H0z" fill="none" />
101              <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"/>
102            </svg>
103          </button>
104        </div>
105        <div id="gtoc">
106          <ul>
107            <li>
108              <a href="index.html">Index</a>
109            </li>
110            <li>
111              <a href="all.html">View on single page</a>
112            </li>
113            <li>
114              <a href="index.json">View as JSON</a>
115            </li>
116
117    <li class="version-picker">
118      <a href="#">View another version <span>&#x25bc;</span></a>
119      <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v19.x/api/index.html">19.x</a></li>
120<li><a href="https://nodejs.org/docs/latest-v18.x/api/index.html">18.x <b>LTS</b></a></li>
121<li><a href="https://nodejs.org/docs/latest-v17.x/api/index.html">17.x</a></li>
122<li><a href="https://nodejs.org/docs/latest-v16.x/api/index.html">16.x <b>LTS</b></a></li>
123<li><a href="https://nodejs.org/docs/latest-v15.x/api/index.html">15.x</a></li>
124<li><a href="https://nodejs.org/docs/latest-v14.x/api/index.html">14.x <b>LTS</b></a></li>
125<li><a href="https://nodejs.org/docs/latest-v13.x/api/index.html">13.x</a></li>
126<li><a href="https://nodejs.org/docs/latest-v12.x/api/index.html">12.x</a></li>
127<li><a href="https://nodejs.org/docs/latest-v11.x/api/index.html">11.x</a></li>
128<li><a href="https://nodejs.org/docs/latest-v10.x/api/index.html">10.x</a></li>
129<li><a href="https://nodejs.org/docs/latest-v9.x/api/index.html">9.x</a></li>
130<li><a href="https://nodejs.org/docs/latest-v8.x/api/index.html">8.x</a></li>
131<li><a href="https://nodejs.org/docs/latest-v7.x/api/index.html">7.x</a></li>
132<li><a href="https://nodejs.org/docs/latest-v6.x/api/index.html">6.x</a></li>
133<li><a href="https://nodejs.org/docs/latest-v5.x/api/index.html">5.x</a></li>
134<li><a href="https://nodejs.org/docs/latest-v4.x/api/index.html">4.x</a></li>
135<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/index.html">0.12.x</a></li>
136<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/index.html">0.10.x</a></li></ol>
137    </li>
138
139            <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/index.md">Edit on GitHub</a></li>
140          </ul>
141        </div>
142        <hr>
143      </header>
144
145      <!-- TOC -->
146
147      <div id="apicontent">
148        <!--
149  NB(chrisdickinson): if you move this file, be sure to update
150  tools/doc/html.mjs to point at the new location.
151-->
152<!--introduced_in=v0.10.0-->
153<ul>
154<li><a href="documentation.html">About this documentation</a></li>
155<li><a href="synopsis.html">Usage and example</a></li>
156</ul>
157<hr class="line">
158<ul>
159<li><a href="assert.html">Assertion testing</a></li>
160<li><a href="async_hooks.html">Async hooks</a></li>
161<li><a href="buffer.html">Buffer</a></li>
162<li><a href="addons.html">C++ addons</a></li>
163<li><a href="n-api.html">C/C++ addons with Node-API</a></li>
164<li><a href="embedding.html">C++ embedder API</a></li>
165<li><a href="child_process.html">Child processes</a></li>
166<li><a href="cluster.html">Cluster</a></li>
167<li><a href="cli.html">Command-line options</a></li>
168<li><a href="console.html">Console</a></li>
169<li><a href="corepack.html">Corepack</a></li>
170<li><a href="crypto.html">Crypto</a></li>
171<li><a href="debugger.html">Debugger</a></li>
172<li><a href="deprecations.html">Deprecated APIs</a></li>
173<li><a href="diagnostics_channel.html">Diagnostics Channel</a></li>
174<li><a href="dns.html">DNS</a></li>
175<li><a href="domain.html">Domain</a></li>
176<li><a href="errors.html">Errors</a></li>
177<li><a href="events.html">Events</a></li>
178<li><a href="fs.html">File system</a></li>
179<li><a href="globals.html">Globals</a></li>
180<li><a href="http.html">HTTP</a></li>
181<li><a href="http2.html">HTTP/2</a></li>
182<li><a href="https.html">HTTPS</a></li>
183<li><a href="inspector.html">Inspector</a></li>
184<li><a href="intl.html">Internationalization</a></li>
185<li><a href="modules.html">Modules: CommonJS modules</a></li>
186<li><a href="esm.html">Modules: ECMAScript modules</a></li>
187<li><a href="module.html">Modules: <code>module</code> API</a></li>
188<li><a href="packages.html">Modules: Packages</a></li>
189<li><a href="net.html">Net</a></li>
190<li><a href="os.html">OS</a></li>
191<li><a href="path.html">Path</a></li>
192<li><a href="perf_hooks.html">Performance hooks</a></li>
193<li><a href="policy.html">Policies</a></li>
194<li><a href="process.html">Process</a></li>
195<li><a href="punycode.html">Punycode</a></li>
196<li><a href="querystring.html">Query strings</a></li>
197<li><a href="readline.html">Readline</a></li>
198<li><a href="repl.html">REPL</a></li>
199<li><a href="report.html">Report</a></li>
200<li><a href="stream.html">Stream</a></li>
201<li><a href="string_decoder.html">String decoder</a></li>
202<li><a href="timers.html">Timers</a></li>
203<li><a href="tls.html">TLS/SSL</a></li>
204<li><a href="tracing.html">Trace events</a></li>
205<li><a href="tty.html">TTY</a></li>
206<li><a href="dgram.html">UDP/datagram</a></li>
207<li><a href="url.html">URL</a></li>
208<li><a href="util.html">Utilities</a></li>
209<li><a href="v8.html">V8</a></li>
210<li><a href="vm.html">VM</a></li>
211<li><a href="wasi.html">WASI</a></li>
212<li><a href="worker_threads.html">Worker threads</a></li>
213<li><a href="zlib.html">Zlib</a></li>
214</ul>
215<hr class="line">
216<ul>
217<li><a href="https://github.com/nodejs/node">Code repository and issue tracker</a></li>
218</ul>
219        <!-- API END -->
220      </div>
221    </div>
222  </div>
223  <script>
224    'use strict';
225    {
226      const kCustomPreference = 'customDarkTheme';
227      const userSettings = sessionStorage.getItem(kCustomPreference);
228      const themeToggleButton = document.getElementById('theme-toggle-btn');
229      if (userSettings === null && window.matchMedia) {
230        const mq = window.matchMedia('(prefers-color-scheme: dark)');
231        if ('onchange' in mq) {
232          function mqChangeListener(e) {
233            document.body.classList.toggle('dark-mode', e.matches);
234          }
235          mq.addEventListener('change', mqChangeListener);
236          if (themeToggleButton) {
237            themeToggleButton.addEventListener('click', function() {
238              mq.removeEventListener('change', mqChangeListener);
239            }, { once: true });
240          }
241        }
242        if (mq.matches) {
243          document.body.classList.add('dark-mode');
244        }
245      } else if (userSettings === 'true') {
246        document.body.classList.add('dark-mode');
247      }
248      if (themeToggleButton) {
249        themeToggleButton.hidden = false;
250        themeToggleButton.addEventListener('click', function() {
251          sessionStorage.setItem(
252            kCustomPreference,
253            document.body.classList.toggle('dark-mode')
254          );
255        });
256      }
257    }
258  </script>
259</body>
260</html>
261