11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>About this documentation | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/documentation.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-documentation"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation active">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="documentation" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <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"/> 1041cb0ef41Sopenharmony_ci <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"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <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"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><a href="#about-this-documentation">About this documentation</a> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#contributing">Contributing</a></li> 1261cb0ef41Sopenharmony_ci<li><a href="#stability-index">Stability index</a></li> 1271cb0ef41Sopenharmony_ci<li><a href="#stability-overview">Stability overview</a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#json-output">JSON output</a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#system-calls-and-man-pages">System calls and man pages</a></li> 1301cb0ef41Sopenharmony_ci</ul> 1311cb0ef41Sopenharmony_ci</li> 1321cb0ef41Sopenharmony_ci</ul></div></div> 1331cb0ef41Sopenharmony_ci </li> 1341cb0ef41Sopenharmony_ci 1351cb0ef41Sopenharmony_ci 1361cb0ef41Sopenharmony_ci <li class="picker-header"> 1371cb0ef41Sopenharmony_ci <a href="#"> 1381cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1391cb0ef41Sopenharmony_ci Index 1401cb0ef41Sopenharmony_ci </a> 1411cb0ef41Sopenharmony_ci 1421cb0ef41Sopenharmony_ci <div class="picker"><ul> 1431cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation active">About this documentation</a></li> 1441cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1451cb0ef41Sopenharmony_ci 1461cb0ef41Sopenharmony_ci <li> 1471cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1481cb0ef41Sopenharmony_ci </li> 1491cb0ef41Sopenharmony_ci </ul> 1501cb0ef41Sopenharmony_ci 1511cb0ef41Sopenharmony_ci<hr class="line"> 1521cb0ef41Sopenharmony_ci<ul> 1531cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1541cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1551cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1561cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1571cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1581cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1591cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1601cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1611cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1631cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1641cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2131cb0ef41Sopenharmony_ci</ul> 2141cb0ef41Sopenharmony_ci<hr class="line"> 2151cb0ef41Sopenharmony_ci<ul> 2161cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2171cb0ef41Sopenharmony_ci</ul></div> 2181cb0ef41Sopenharmony_ci </li> 2191cb0ef41Sopenharmony_ci 2201cb0ef41Sopenharmony_ci 2211cb0ef41Sopenharmony_ci <li class="picker-header"> 2221cb0ef41Sopenharmony_ci <a href="#"> 2231cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2241cb0ef41Sopenharmony_ci Other versions 2251cb0ef41Sopenharmony_ci </a> 2261cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/documentation.html">21.x</a></li> 2271cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/documentation.html">20.x <b>LTS</b></a></li> 2281cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/documentation.html">19.x</a></li> 2291cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/documentation.html">18.x <b>LTS</b></a></li> 2301cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/documentation.html">17.x</a></li> 2311cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/documentation.html">16.x</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/documentation.html">15.x</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/documentation.html">14.x</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/documentation.html">13.x</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/documentation.html">12.x</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/documentation.html">11.x</a></li> 2371cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/documentation.html">10.x</a></li> 2381cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/documentation.html">9.x</a></li> 2391cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/documentation.html">8.x</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/documentation.html">7.x</a></li> 2411cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/documentation.html">6.x</a></li> 2421cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/documentation.html">5.x</a></li> 2431cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/documentation.html">4.x</a></li> 2441cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/documentation.html">0.12.x</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/documentation.html">0.10.x</a></li></ol></div> 2461cb0ef41Sopenharmony_ci </li> 2471cb0ef41Sopenharmony_ci 2481cb0ef41Sopenharmony_ci <li class="picker-header"> 2491cb0ef41Sopenharmony_ci <a href="#"> 2501cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2511cb0ef41Sopenharmony_ci Options 2521cb0ef41Sopenharmony_ci </a> 2531cb0ef41Sopenharmony_ci 2541cb0ef41Sopenharmony_ci <div class="picker"> 2551cb0ef41Sopenharmony_ci <ul> 2561cb0ef41Sopenharmony_ci <li> 2571cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2581cb0ef41Sopenharmony_ci </li> 2591cb0ef41Sopenharmony_ci <li> 2601cb0ef41Sopenharmony_ci <a href="documentation.json">View as JSON</a> 2611cb0ef41Sopenharmony_ci </li> 2621cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/documentation.md">Edit on GitHub</a></li> 2631cb0ef41Sopenharmony_ci </ul> 2641cb0ef41Sopenharmony_ci </div> 2651cb0ef41Sopenharmony_ci </li> 2661cb0ef41Sopenharmony_ci </ul> 2671cb0ef41Sopenharmony_ci </div> 2681cb0ef41Sopenharmony_ci <hr> 2691cb0ef41Sopenharmony_ci </header> 2701cb0ef41Sopenharmony_ci 2711cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2721cb0ef41Sopenharmony_ci<li><a href="#about-this-documentation">About this documentation</a> 2731cb0ef41Sopenharmony_ci<ul> 2741cb0ef41Sopenharmony_ci<li><a href="#contributing">Contributing</a></li> 2751cb0ef41Sopenharmony_ci<li><a href="#stability-index">Stability index</a></li> 2761cb0ef41Sopenharmony_ci<li><a href="#stability-overview">Stability overview</a></li> 2771cb0ef41Sopenharmony_ci<li><a href="#json-output">JSON output</a></li> 2781cb0ef41Sopenharmony_ci<li><a href="#system-calls-and-man-pages">System calls and man pages</a></li> 2791cb0ef41Sopenharmony_ci</ul> 2801cb0ef41Sopenharmony_ci</li> 2811cb0ef41Sopenharmony_ci</ul></details> 2821cb0ef41Sopenharmony_ci 2831cb0ef41Sopenharmony_ci <div id="apicontent"> 2841cb0ef41Sopenharmony_ci <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> 2851cb0ef41Sopenharmony_ci 2861cb0ef41Sopenharmony_ci 2871cb0ef41Sopenharmony_ci<p>Welcome to the official API reference documentation for Node.js!</p> 2881cb0ef41Sopenharmony_ci<p>Node.js is a JavaScript runtime built on the <a href="https://v8.dev/">V8 JavaScript engine</a>.</p> 2891cb0ef41Sopenharmony_ci<section><h3>Contributing<span><a class="mark" href="#contributing" id="contributing">#</a></span><a aria-hidden="true" class="legacy" id="documentation_contributing"></a></h3> 2901cb0ef41Sopenharmony_ci<p>Report errors in this documentation in <a href="https://github.com/nodejs/node/issues/new">the issue tracker</a>. See 2911cb0ef41Sopenharmony_ci<a href="https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md">the contributing guide</a> for directions on how to submit pull requests.</p> 2921cb0ef41Sopenharmony_ci</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> 2931cb0ef41Sopenharmony_ci 2941cb0ef41Sopenharmony_ci<p>Throughout the documentation are indications of a section's stability. Some APIs 2951cb0ef41Sopenharmony_ciare so proven and so relied upon that they are unlikely to ever change at all. 2961cb0ef41Sopenharmony_ciOthers are brand new and experimental, or known to be hazardous.</p> 2971cb0ef41Sopenharmony_ci<p>The stability indices are as follows:</p> 2981cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_0">Stability: 0 - Deprecated. The feature may emit warnings. Backward 2991cb0ef41Sopenharmony_cicompatibility is not guaranteed.</div><p></p> 3001cb0ef41Sopenharmony_ci<!-- separator --> 3011cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1">Stability: 1 - Experimental. The feature is not subject to 3021cb0ef41Sopenharmony_ci<a href="https://semver.org/">semantic versioning</a> rules. Non-backward compatible changes or removal may 3031cb0ef41Sopenharmony_cioccur in any future release. Use of the feature is not recommended in 3041cb0ef41Sopenharmony_ciproduction environments.</div><p></p> 3051cb0ef41Sopenharmony_ci<!-- separator --> 3061cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2">Stability: 2 - Stable. Compatibility with the npm ecosystem is a high 3071cb0ef41Sopenharmony_cipriority.</div><p></p> 3081cb0ef41Sopenharmony_ci<!-- separator --> 3091cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_3">Stability: 3 - Legacy. Although this feature is unlikely to be removed and is 3101cb0ef41Sopenharmony_cistill covered by semantic versioning guarantees, it is no longer actively 3111cb0ef41Sopenharmony_cimaintained, and other alternatives are available.</div><p></p> 3121cb0ef41Sopenharmony_ci<p>Features are marked as legacy rather than being deprecated if their use does no 3131cb0ef41Sopenharmony_ciharm, and they are widely relied upon within the npm ecosystem. Bugs found in 3141cb0ef41Sopenharmony_cilegacy features are unlikely to be fixed.</p> 3151cb0ef41Sopenharmony_ci<p>Use caution when making use of Experimental features, particularly within 3161cb0ef41Sopenharmony_cimodules. Users may not be aware that experimental features are being used. 3171cb0ef41Sopenharmony_ciBugs or behavior changes may surprise users when Experimental API 3181cb0ef41Sopenharmony_cimodifications occur. To avoid surprises, use of an Experimental feature may need 3191cb0ef41Sopenharmony_cia command-line flag. Experimental features may also emit a <a href="process.html#event-warning">warning</a>.</p> 3201cb0ef41Sopenharmony_ci</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> 3211cb0ef41Sopenharmony_ci<!-- 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) .1 - Active development</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) Experimental: This feature is being designed and will change.</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_1">(1) Experimental</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_1">(1) Experimental</td></tr><tr><td class="module_stability"><a href="webstreams.html">Web Streams API</a></td><td class="api_stability api_stability_1">(1) Experimental.</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 --> 3221cb0ef41Sopenharmony_ci</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> 3231cb0ef41Sopenharmony_ci<div class="api_metadata"> 3241cb0ef41Sopenharmony_ci<span>Added in: v0.6.12</span> 3251cb0ef41Sopenharmony_ci</div> 3261cb0ef41Sopenharmony_ci<p>Every <code>.html</code> document has a corresponding <code>.json</code> document. This is for IDEs 3271cb0ef41Sopenharmony_ciand other utilities that consume the documentation.</p> 3281cb0ef41Sopenharmony_ci</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> 3291cb0ef41Sopenharmony_ci<p>Node.js functions which wrap a system call will document that. The docs link 3301cb0ef41Sopenharmony_cito the corresponding man pages which describe how the system call works.</p> 3311cb0ef41Sopenharmony_ci<p>Most Unix system calls have Windows analogues. Still, behavior differences may 3321cb0ef41Sopenharmony_cibe unavoidable.</p></section> 3331cb0ef41Sopenharmony_ci <!-- API END --> 3341cb0ef41Sopenharmony_ci </div> 3351cb0ef41Sopenharmony_ci </div> 3361cb0ef41Sopenharmony_ci </div> 3371cb0ef41Sopenharmony_ci</body> 3381cb0ef41Sopenharmony_ci</html> 339