<!doctype html><html lang=en><meta charset=utf-8><meta name=viewport content="width=device-width"><link rel=icon href=https://nodejs.org/favicon.ico><meta name=nodejs.org:node-version content=v26.3.0><title>Index | Node.js v26.3.0 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=canonical href=https://nodejs.org/api/index.html><script async defer src=assets/api.js></script><script>("dark"===localStorage.getItem("theme")||null===localStorage.getItem("theme")&&window.matchMedia?.("(prefers-color-scheme: dark)").matches)&&document.documentElement.classList.add("dark-mode")</script><body class="alt apidoc" id=api-section-index><a href=#apicontent class=skip-to-content>Skip to content</a>
    <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>
        <hr class=line>
        <ul>
<li><a class=nav-documentation href=documentation.html>About this documentation</a></li>
<li><a class=nav-synopsis href=synopsis.html>Usage and example</a></li>
<li><a class=nav-assert href=assert.html>Assertion testing</a></li>
<li><a class=nav-async_context href=async_context.html>Asynchronous context tracking</a></li>
<li><a class=nav-async_hooks href=async_hooks.html>Async hooks</a></li>
<li><a class=nav-buffer href=buffer.html>Buffer</a></li>
<li><a class=nav-addons href=addons.html>C++ addons</a></li>
<li><a class=nav-n-api href=n-api.html>C/C++ addons with Node-API</a></li>
<li><a class=nav-embedding href=embedding.html>C++ embedder API</a></li>
<li><a class=nav-child_process href=child_process.html>Child processes</a></li>
<li><a class=nav-cluster href=cluster.html>Cluster</a></li>
<li><a class=nav-cli href=cli.html>Command-line options</a></li>
<li><a class=nav-console href=console.html>Console</a></li>
<li><a class=nav-crypto href=crypto.html>Crypto</a></li>
<li><a class=nav-debugger href=debugger.html>Debugger</a></li>
<li><a class=nav-deprecations href=deprecations.html>Deprecated APIs</a></li>
<li><a class=nav-diagnostics_channel href=diagnostics_channel.html>Diagnostics Channel</a></li>
<li><a class=nav-dns href=dns.html>DNS</a></li>
<li><a class=nav-domain href=domain.html>Domain</a></li>
<li><a class=nav-environment_variables href=environment_variables.html>Environment Variables</a></li>
<li><a class=nav-errors href=errors.html>Errors</a></li>
<li><a class=nav-events href=events.html>Events</a></li>
<li><a class=nav-fs href=fs.html>File system</a></li>
<li><a class=nav-ffi href=ffi.html>FFI</a></li>
<li><a class=nav-globals href=globals.html>Globals</a></li>
<li><a class=nav-http href=http.html>HTTP</a></li>
<li><a class=nav-http2 href=http2.html>HTTP/2</a></li>
<li><a class=nav-https href=https.html>HTTPS</a></li>
<li><a class=nav-inspector href=inspector.html>Inspector</a></li>
<li><a class=nav-intl href=intl.html>Internationalization</a></li>
<li><a class=nav-stream_iter href=stream_iter.html>Iterable Streams API</a></li>
<li><a class=nav-modules href=modules.html>Modules: CommonJS modules</a></li>
<li><a class=nav-esm href=esm.html>Modules: ECMAScript modules</a></li>
<li><a class=nav-module href=module.html>Modules: <code>node:module</code> API</a></li>
<li><a class=nav-packages href=packages.html>Modules: Packages</a></li>
<li><a class=nav-typescript href=typescript.html>Modules: TypeScript</a></li>
<li><a class=nav-net href=net.html>Net</a></li>
<li><a class=nav-os href=os.html>OS</a></li>
<li><a class=nav-path href=path.html>Path</a></li>
<li><a class=nav-perf_hooks href=perf_hooks.html>Performance hooks</a></li>
<li><a class=nav-permissions href=permissions.html>Permissions</a></li>
<li><a class=nav-process href=process.html>Process</a></li>
<li><a class=nav-punycode href=punycode.html>Punycode</a></li>
<li><a class=nav-querystring href=querystring.html>Query strings</a></li>
<li><a class=nav-readline href=readline.html>Readline</a></li>
<li><a class=nav-repl href=repl.html>REPL</a></li>
<li><a class=nav-report href=report.html>Report</a></li>
<li><a class=nav-single-executable-applications href=single-executable-applications.html>Single executable applications</a></li>
<li><a class=nav-sqlite href=sqlite.html>SQLite</a></li>
<li><a class=nav-stream href=stream.html>Stream</a></li>
<li><a class=nav-string_decoder href=string_decoder.html>String decoder</a></li>
<li><a class=nav-test href=test.html>Test runner</a></li>
<li><a class=nav-timers href=timers.html>Timers</a></li>
<li><a class=nav-tls href=tls.html>TLS/SSL</a></li>
<li><a class=nav-tracing href=tracing.html>Trace events</a></li>
<li><a class=nav-tty href=tty.html>TTY</a></li>
<li><a class=nav-dgram href=dgram.html>UDP/datagram</a></li>
<li><a class=nav-url href=url.html>URL</a></li>
<li><a class=nav-util href=util.html>Utilities</a></li>
<li><a class=nav-v8 href=v8.html>V8</a></li>
<li><a class=nav-vm href=vm.html>VM</a></li>
<li><a class=nav-wasi href=wasi.html>WASI</a></li>
<li><a class=nav-webcrypto href=webcrypto.html>Web Crypto API</a></li>
<li><a class=nav-webstreams href=webstreams.html>Web Streams API</a></li>
<li><a class=nav-worker_threads href=worker_threads.html>Worker threads</a></li>
<li><a class=nav-zlib href=zlib.html>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=index class=interior>
        <header class=header>
          <div class=header-container>
            <h1>Node.js v26.3.0 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 class="dark-icon 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 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 v26.3.0</li>
              <li class=picker-header><a href=#toc-picker aria-controls=toc-picker><span class=picker-arrow></span>Table of contents</a><div class=picker><div class=toc tabindex=-1><ul id=toc-picker>
<li><a href=index.html#index>Index</a></li>
</ul></div></div></li> <li class=picker-header><a href=#gtoc-picker aria-controls=gtoc-picker><span class=picker-arrow></span>Index</a><div class=picker tabindex=-1 id=gtoc-picker><ul><li><a href=index.html>Index</a></ul><hr class=line><ul>
<li><a class=nav-documentation href=documentation.html>About this documentation</a></li>
<li><a class=nav-synopsis href=synopsis.html>Usage and example</a></li>
<li><a class=nav-assert href=assert.html>Assertion testing</a></li>
<li><a class=nav-async_context href=async_context.html>Asynchronous context tracking</a></li>
<li><a class=nav-async_hooks href=async_hooks.html>Async hooks</a></li>
<li><a class=nav-buffer href=buffer.html>Buffer</a></li>
<li><a class=nav-addons href=addons.html>C++ addons</a></li>
<li><a class=nav-n-api href=n-api.html>C/C++ addons with Node-API</a></li>
<li><a class=nav-embedding href=embedding.html>C++ embedder API</a></li>
<li><a class=nav-child_process href=child_process.html>Child processes</a></li>
<li><a class=nav-cluster href=cluster.html>Cluster</a></li>
<li><a class=nav-cli href=cli.html>Command-line options</a></li>
<li><a class=nav-console href=console.html>Console</a></li>
<li><a class=nav-crypto href=crypto.html>Crypto</a></li>
<li><a class=nav-debugger href=debugger.html>Debugger</a></li>
<li><a class=nav-deprecations href=deprecations.html>Deprecated APIs</a></li>
<li><a class=nav-diagnostics_channel href=diagnostics_channel.html>Diagnostics Channel</a></li>
<li><a class=nav-dns href=dns.html>DNS</a></li>
<li><a class=nav-domain href=domain.html>Domain</a></li>
<li><a class=nav-environment_variables href=environment_variables.html>Environment Variables</a></li>
<li><a class=nav-errors href=errors.html>Errors</a></li>
<li><a class=nav-events href=events.html>Events</a></li>
<li><a class=nav-fs href=fs.html>File system</a></li>
<li><a class=nav-ffi href=ffi.html>FFI</a></li>
<li><a class=nav-globals href=globals.html>Globals</a></li>
<li><a class=nav-http href=http.html>HTTP</a></li>
<li><a class=nav-http2 href=http2.html>HTTP/2</a></li>
<li><a class=nav-https href=https.html>HTTPS</a></li>
<li><a class=nav-inspector href=inspector.html>Inspector</a></li>
<li><a class=nav-intl href=intl.html>Internationalization</a></li>
<li><a class=nav-stream_iter href=stream_iter.html>Iterable Streams API</a></li>
<li><a class=nav-modules href=modules.html>Modules: CommonJS modules</a></li>
<li><a class=nav-esm href=esm.html>Modules: ECMAScript modules</a></li>
<li><a class=nav-module href=module.html>Modules: <code>node:module</code> API</a></li>
<li><a class=nav-packages href=packages.html>Modules: Packages</a></li>
<li><a class=nav-typescript href=typescript.html>Modules: TypeScript</a></li>
<li><a class=nav-net href=net.html>Net</a></li>
<li><a class=nav-os href=os.html>OS</a></li>
<li><a class=nav-path href=path.html>Path</a></li>
<li><a class=nav-perf_hooks href=perf_hooks.html>Performance hooks</a></li>
<li><a class=nav-permissions href=permissions.html>Permissions</a></li>
<li><a class=nav-process href=process.html>Process</a></li>
<li><a class=nav-punycode href=punycode.html>Punycode</a></li>
<li><a class=nav-querystring href=querystring.html>Query strings</a></li>
<li><a class=nav-readline href=readline.html>Readline</a></li>
<li><a class=nav-repl href=repl.html>REPL</a></li>
<li><a class=nav-report href=report.html>Report</a></li>
<li><a class=nav-single-executable-applications href=single-executable-applications.html>Single executable applications</a></li>
<li><a class=nav-sqlite href=sqlite.html>SQLite</a></li>
<li><a class=nav-stream href=stream.html>Stream</a></li>
<li><a class=nav-string_decoder href=string_decoder.html>String decoder</a></li>
<li><a class=nav-test href=test.html>Test runner</a></li>
<li><a class=nav-timers href=timers.html>Timers</a></li>
<li><a class=nav-tls href=tls.html>TLS/SSL</a></li>
<li><a class=nav-tracing href=tracing.html>Trace events</a></li>
<li><a class=nav-tty href=tty.html>TTY</a></li>
<li><a class=nav-dgram href=dgram.html>UDP/datagram</a></li>
<li><a class=nav-url href=url.html>URL</a></li>
<li><a class=nav-util href=util.html>Utilities</a></li>
<li><a class=nav-v8 href=v8.html>V8</a></li>
<li><a class=nav-vm href=vm.html>VM</a></li>
<li><a class=nav-wasi href=wasi.html>WASI</a></li>
<li><a class=nav-webcrypto href=webcrypto.html>Web Crypto API</a></li>
<li><a class=nav-webstreams href=webstreams.html>Web Streams API</a></li>
<li><a class=nav-worker_threads href=worker_threads.html>Worker threads</a></li>
<li><a class=nav-zlib href=zlib.html>Zlib</a></li>
</ul></div></li> <li class=picker-header><a href=#alt-docs aria-controls=alt-docs><span class=picker-arrow></span>Other versions</a><div class=picker tabindex=-1><ol id=alt-docs><li><a href=https://nodejs.org/docs/latest-v26.x/api/index.html>26.x </a><li><a href=https://nodejs.org/docs/latest-v25.x/api/index.html>25.x </a><li><a href=https://nodejs.org/docs/latest-v24.x/api/index.html>24.x <b>LTS</b></a><li><a href=https://nodejs.org/docs/latest-v23.x/api/index.html>23.x </a><li><a href=https://nodejs.org/docs/latest-v22.x/api/index.html>22.x <b>LTS</b></a><li><a href=https://nodejs.org/docs/latest-v21.x/api/index.html>21.x </a><li><a href=https://nodejs.org/docs/latest-v20.x/api/index.html>20.x </a><li><a href=https://nodejs.org/docs/latest-v19.x/api/index.html>19.x </a><li><a href=https://nodejs.org/docs/latest-v18.x/api/index.html>18.x </a><li><a href=https://nodejs.org/docs/latest-v17.x/api/index.html>17.x </a><li><a href=https://nodejs.org/docs/latest-v16.x/api/index.html>16.x </a><li><a href=https://nodejs.org/docs/latest-v15.x/api/index.html>15.x </a><li><a href=https://nodejs.org/docs/latest-v14.x/api/index.html>14.x </a><li><a href=https://nodejs.org/docs/latest-v13.x/api/index.html>13.x </a><li><a href=https://nodejs.org/docs/latest-v12.x/api/index.html>12.x </a><li><a href=https://nodejs.org/docs/latest-v11.x/api/index.html>11.x </a><li><a href=https://nodejs.org/docs/latest-v10.x/api/index.html>10.x </a><li><a href=https://nodejs.org/docs/latest-v9.x/api/index.html>9.x </a><li><a href=https://nodejs.org/docs/latest-v8.x/api/index.html>8.x </a><li><a href=https://nodejs.org/docs/latest-v7.x/api/index.html>7.x </a><li><a href=https://nodejs.org/docs/latest-v6.x/api/index.html>6.x </a><li><a href=https://nodejs.org/docs/latest-v5.x/api/index.html>5.x </a><li><a href=https://nodejs.org/docs/latest-v4.x/api/index.html>4.x </a><li><a href=https://nodejs.org/docs/latest-v0.12.x/api/index.html>0.12.x </a><li><a href=https://nodejs.org/docs/latest-v0.10.x/api/index.html>0.10.x </a></ol></div></li>
              <li class=picker-header>
                <a href=#options-picker aria-controls=options-picker>
                  <span class=picker-arrow></span>
                  Options
                </a>
                <div class=picker tabindex=-1>
                  <ul id=options-picker>
                    <li>
                      <a href=all.html>View on single page</a>
                    </li>
                    <li>
                      <a href=index.json>View as JSON</a>
                    </li>
                    <li class=edit_on_github><a href=https://github.com/nodejs/node/edit/main/doc/api/index.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=index.html#index>Index</a></li>
</ul></details>
        <div role=main id=apicontent>
          <section><h2>Index<span><a id=index_index></a></span><span><a class=mark id=index href=#index>#</a></span></h2><div class=api_metadata></div><ul>
<li><a href=documentation.html>About this documentation</a></li>
<li><a href=synopsis.html>Usage and example</a></li>
</ul><hr class=line><ul>
<li><a href=assert.html>Assertion testing</a></li>
<li><a href=async_context.html>Asynchronous context tracking</a></li>
<li><a href=async_hooks.html>Async hooks</a></li>
<li><a href=buffer.html>Buffer</a></li>
<li><a href=addons.html>C++ addons</a></li>
<li><a href=n-api.html>C/C++ addons with Node-API</a></li>
<li><a href=embedding.html>C++ embedder API</a></li>
<li><a href=child_process.html>Child processes</a></li>
<li><a href=cluster.html>Cluster</a></li>
<li><a href=cli.html>Command-line options</a></li>
<li><a href=console.html>Console</a></li>
<li><a href=crypto.html>Crypto</a></li>
<li><a href=debugger.html>Debugger</a></li>
<li><a href=deprecations.html>Deprecated APIs</a></li>
<li><a href=diagnostics_channel.html>Diagnostics Channel</a></li>
<li><a href=dns.html>DNS</a></li>
<li><a href=domain.html>Domain</a></li>
<li><a href=environment_variables.html>Environment Variables</a></li>
<li><a href=errors.html>Errors</a></li>
<li><a href=events.html>Events</a></li>
<li><a href=fs.html>File system</a></li>
<li><a href=ffi.html>FFI</a></li>
<li><a href=globals.html>Globals</a></li>
<li><a href=http.html>HTTP</a></li>
<li><a href=http2.html>HTTP/2</a></li>
<li><a href=https.html>HTTPS</a></li>
<li><a href=inspector.html>Inspector</a></li>
<li><a href=intl.html>Internationalization</a></li>
<li><a href=stream_iter.html>Iterable Streams API</a></li>
<li><a href=modules.html>Modules: CommonJS modules</a></li>
<li><a href=esm.html>Modules: ECMAScript modules</a></li>
<li><a href=module.html>Modules: <code>node:module</code> API</a></li>
<li><a href=packages.html>Modules: Packages</a></li>
<li><a href=typescript.html>Modules: TypeScript</a></li>
<li><a href=net.html>Net</a></li>
<li><a href=os.html>OS</a></li>
<li><a href=path.html>Path</a></li>
<li><a href=perf_hooks.html>Performance hooks</a></li>
<li><a href=permissions.html>Permissions</a></li>
<li><a href=process.html>Process</a></li>
<li><a href=punycode.html>Punycode</a></li>
<li><a href=querystring.html>Query strings</a></li>
<li><a href=readline.html>Readline</a></li>
<li><a href=repl.html>REPL</a></li>
<li><a href=report.html>Report</a></li>
<li><a href=single-executable-applications.html>Single executable applications</a></li>
<li><a href=sqlite.html>SQLite</a></li>
<li><a href=stream.html>Stream</a></li>
<li><a href=string_decoder.html>String decoder</a></li>
<li><a href=test.html>Test runner</a></li>
<li><a href=timers.html>Timers</a></li>
<li><a href=tls.html>TLS/SSL</a></li>
<li><a href=tracing.html>Trace events</a></li>
<li><a href=tty.html>TTY</a></li>
<li><a href=dgram.html>UDP/datagram</a></li>
<li><a href=url.html>URL</a></li>
<li><a href=util.html>Utilities</a></li>
<li><a href=v8.html>V8</a></li>
<li><a href=vm.html>VM</a></li>
<li><a href=wasi.html>WASI</a></li>
<li><a href=webcrypto.html>Web Crypto API</a></li>
<li><a href=webstreams.html>Web Streams API</a></li>
<li><a href=worker_threads.html>Worker threads</a></li>
<li><a href=zlib.html>Zlib</a></li>
</ul><hr class=line><ul>
<li><a href=https://github.com/nodejs/node>Code repository and issue tracker</a></li>
</ul></section>
          
        </div>
      </div>
    </div>