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>Usage and example | 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/synopsis.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-synopsis"> 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">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis active">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="synopsis" 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="#usage-and-example">Usage and example</a> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#usage">Usage</a></li> 1261cb0ef41Sopenharmony_ci<li><a href="#example">Example</a></li> 1271cb0ef41Sopenharmony_ci</ul> 1281cb0ef41Sopenharmony_ci</li> 1291cb0ef41Sopenharmony_ci</ul></div></div> 1301cb0ef41Sopenharmony_ci </li> 1311cb0ef41Sopenharmony_ci 1321cb0ef41Sopenharmony_ci 1331cb0ef41Sopenharmony_ci <li class="picker-header"> 1341cb0ef41Sopenharmony_ci <a href="#"> 1351cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1361cb0ef41Sopenharmony_ci Index 1371cb0ef41Sopenharmony_ci </a> 1381cb0ef41Sopenharmony_ci 1391cb0ef41Sopenharmony_ci <div class="picker"><ul> 1401cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1411cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis active">Usage and example</a></li> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci <li> 1441cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1451cb0ef41Sopenharmony_ci </li> 1461cb0ef41Sopenharmony_ci </ul> 1471cb0ef41Sopenharmony_ci 1481cb0ef41Sopenharmony_ci<hr class="line"> 1491cb0ef41Sopenharmony_ci<ul> 1501cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1511cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1521cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1531cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1541cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1551cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1561cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1571cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1581cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1591cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1601cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1611cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1631cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1641cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2101cb0ef41Sopenharmony_ci</ul> 2111cb0ef41Sopenharmony_ci<hr class="line"> 2121cb0ef41Sopenharmony_ci<ul> 2131cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2141cb0ef41Sopenharmony_ci</ul></div> 2151cb0ef41Sopenharmony_ci </li> 2161cb0ef41Sopenharmony_ci 2171cb0ef41Sopenharmony_ci 2181cb0ef41Sopenharmony_ci <li class="picker-header"> 2191cb0ef41Sopenharmony_ci <a href="#"> 2201cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2211cb0ef41Sopenharmony_ci Other versions 2221cb0ef41Sopenharmony_ci </a> 2231cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/synopsis.html">21.x</a></li> 2241cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/synopsis.html">20.x <b>LTS</b></a></li> 2251cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/synopsis.html">19.x</a></li> 2261cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/synopsis.html">18.x <b>LTS</b></a></li> 2271cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/synopsis.html">17.x</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/synopsis.html">16.x</a></li> 2291cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/synopsis.html">15.x</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/synopsis.html">14.x</a></li> 2311cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/synopsis.html">13.x</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/synopsis.html">12.x</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/synopsis.html">11.x</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/synopsis.html">10.x</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/synopsis.html">9.x</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/synopsis.html">8.x</a></li> 2371cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/synopsis.html">7.x</a></li> 2381cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/synopsis.html">6.x</a></li> 2391cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/synopsis.html">5.x</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/synopsis.html">4.x</a></li> 2411cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/synopsis.html">0.12.x</a></li> 2421cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/synopsis.html">0.10.x</a></li></ol></div> 2431cb0ef41Sopenharmony_ci </li> 2441cb0ef41Sopenharmony_ci 2451cb0ef41Sopenharmony_ci <li class="picker-header"> 2461cb0ef41Sopenharmony_ci <a href="#"> 2471cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2481cb0ef41Sopenharmony_ci Options 2491cb0ef41Sopenharmony_ci </a> 2501cb0ef41Sopenharmony_ci 2511cb0ef41Sopenharmony_ci <div class="picker"> 2521cb0ef41Sopenharmony_ci <ul> 2531cb0ef41Sopenharmony_ci <li> 2541cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2551cb0ef41Sopenharmony_ci </li> 2561cb0ef41Sopenharmony_ci <li> 2571cb0ef41Sopenharmony_ci <a href="synopsis.json">View as JSON</a> 2581cb0ef41Sopenharmony_ci </li> 2591cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/synopsis.md">Edit on GitHub</a></li> 2601cb0ef41Sopenharmony_ci </ul> 2611cb0ef41Sopenharmony_ci </div> 2621cb0ef41Sopenharmony_ci </li> 2631cb0ef41Sopenharmony_ci </ul> 2641cb0ef41Sopenharmony_ci </div> 2651cb0ef41Sopenharmony_ci <hr> 2661cb0ef41Sopenharmony_ci </header> 2671cb0ef41Sopenharmony_ci 2681cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2691cb0ef41Sopenharmony_ci<li><a href="#usage-and-example">Usage and example</a> 2701cb0ef41Sopenharmony_ci<ul> 2711cb0ef41Sopenharmony_ci<li><a href="#usage">Usage</a></li> 2721cb0ef41Sopenharmony_ci<li><a href="#example">Example</a></li> 2731cb0ef41Sopenharmony_ci</ul> 2741cb0ef41Sopenharmony_ci</li> 2751cb0ef41Sopenharmony_ci</ul></details> 2761cb0ef41Sopenharmony_ci 2771cb0ef41Sopenharmony_ci <div id="apicontent"> 2781cb0ef41Sopenharmony_ci <h2>Usage and example<span><a class="mark" href="#usage-and-example" id="usage-and-example">#</a></span><a aria-hidden="true" class="legacy" id="synopsis_usage_and_example"></a></h2> 2791cb0ef41Sopenharmony_ci<section><h3>Usage<span><a class="mark" href="#usage" id="usage">#</a></span><a aria-hidden="true" class="legacy" id="synopsis_usage"></a></h3> 2801cb0ef41Sopenharmony_ci 2811cb0ef41Sopenharmony_ci 2821cb0ef41Sopenharmony_ci<p><code>node [options] [V8 options] [script.js | -e "script" | - ] [arguments]</code></p> 2831cb0ef41Sopenharmony_ci<p>Please see the <a href="cli.html#options">Command-line options</a> document for more information.</p> 2841cb0ef41Sopenharmony_ci</section><section><h3>Example<span><a class="mark" href="#example" id="example">#</a></span><a aria-hidden="true" class="legacy" id="synopsis_example"></a></h3> 2851cb0ef41Sopenharmony_ci<p>An example of a <a href="http.html">web server</a> written with Node.js which responds with 2861cb0ef41Sopenharmony_ci<code>'Hello, World!'</code>:</p> 2871cb0ef41Sopenharmony_ci<p>Commands in this document start with <code>$</code> or <code>></code> to replicate how they would 2881cb0ef41Sopenharmony_ciappear in a user's terminal. Do not include the <code>$</code> and <code>></code> characters. They are 2891cb0ef41Sopenharmony_cithere to show the start of each command.</p> 2901cb0ef41Sopenharmony_ci<p>Lines that don't start with <code>$</code> or <code>></code> character show the output of the previous 2911cb0ef41Sopenharmony_cicommand.</p> 2921cb0ef41Sopenharmony_ci<p>First, make sure to have downloaded and installed Node.js. See 2931cb0ef41Sopenharmony_ci<a href="https://nodejs.org/en/download/package-manager/">Installing Node.js via package manager</a> for further install information.</p> 2941cb0ef41Sopenharmony_ci<p>Now, create an empty project folder called <code>projects</code>, then navigate into it.</p> 2951cb0ef41Sopenharmony_ci<p>Linux and Mac:</p> 2961cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">mkdir</span> ~/projects</span> 2971cb0ef41Sopenharmony_ci<span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">cd</span> ~/projects</span></code> <button class="copy-button">copy</button></pre> 2981cb0ef41Sopenharmony_ci<p>Windows CMD:</p> 2991cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">> </span><span class="language-bash"><span class="hljs-built_in">mkdir</span> %USERPROFILE%\projects</span> 3001cb0ef41Sopenharmony_ci<span class="hljs-meta prompt_">> </span><span class="language-bash"><span class="hljs-built_in">cd</span> %USERPROFILE%\projects</span></code> <button class="copy-button">copy</button></pre> 3011cb0ef41Sopenharmony_ci<p>Windows PowerShell:</p> 3021cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">> </span><span class="language-bash"><span class="hljs-built_in">mkdir</span> <span class="hljs-variable">$env</span>:USERPROFILE\projects</span> 3031cb0ef41Sopenharmony_ci<span class="hljs-meta prompt_">> </span><span class="language-bash"><span class="hljs-built_in">cd</span> <span class="hljs-variable">$env</span>:USERPROFILE\projects</span></code> <button class="copy-button">copy</button></pre> 3041cb0ef41Sopenharmony_ci<p>Next, create a new source file in the <code>projects</code> 3051cb0ef41Sopenharmony_cifolder and call it <code>hello-world.js</code>.</p> 3061cb0ef41Sopenharmony_ci<p>Open <code>hello-world.js</code> in any preferred text editor and 3071cb0ef41Sopenharmony_cipaste in the following content:</p> 3081cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> http = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:http'</span>); 3091cb0ef41Sopenharmony_ci 3101cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> hostname = <span class="hljs-string">'127.0.0.1'</span>; 3111cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> port = <span class="hljs-number">3000</span>; 3121cb0ef41Sopenharmony_ci 3131cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> server = http.<span class="hljs-title function_">createServer</span>(<span class="hljs-function">(<span class="hljs-params">req, res</span>) =></span> { 3141cb0ef41Sopenharmony_ci res.<span class="hljs-property">statusCode</span> = <span class="hljs-number">200</span>; 3151cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">setHeader</span>(<span class="hljs-string">'Content-Type'</span>, <span class="hljs-string">'text/plain'</span>); 3161cb0ef41Sopenharmony_ci res.<span class="hljs-title function_">end</span>(<span class="hljs-string">'Hello, World!\n'</span>); 3171cb0ef41Sopenharmony_ci}); 3181cb0ef41Sopenharmony_ci 3191cb0ef41Sopenharmony_ciserver.<span class="hljs-title function_">listen</span>(port, hostname, <span class="hljs-function">() =></span> { 3201cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Server running at http://<span class="hljs-subst">${hostname}</span>:<span class="hljs-subst">${port}</span>/`</span>); 3211cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 3221cb0ef41Sopenharmony_ci<p>Save the file, go back to the terminal window, and enter the following command:</p> 3231cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">node hello-world.js</span></code> <button class="copy-button">copy</button></pre> 3241cb0ef41Sopenharmony_ci<p>Output like this should appear in the terminal:</p> 3251cb0ef41Sopenharmony_ci<pre><code class="language-console">Server running at http://127.0.0.1:3000/</code> <button class="copy-button">copy</button></pre> 3261cb0ef41Sopenharmony_ci<p>Now, open any preferred web browser and visit <code>http://127.0.0.1:3000</code>.</p> 3271cb0ef41Sopenharmony_ci<p>If the browser displays the string <code>Hello, World!</code>, that indicates 3281cb0ef41Sopenharmony_cithe server is working.</p></section> 3291cb0ef41Sopenharmony_ci <!-- API END --> 3301cb0ef41Sopenharmony_ci </div> 3311cb0ef41Sopenharmony_ci </div> 3321cb0ef41Sopenharmony_ci </div> 3331cb0ef41Sopenharmony_ci</body> 3341cb0ef41Sopenharmony_ci</html> 335