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>Timers | 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/timers.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci <style>@media(max-width:326px){.with-13-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:342px){.with-15-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}@media(max-width:334px){.with-14-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}</style> 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-timers"> 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">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 active">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="timers" 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><span class="stability_2"><a href="#timers">Timers</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#class-immediate">Class: <code>Immediate</code></a> 1261cb0ef41Sopenharmony_ci<ul> 1271cb0ef41Sopenharmony_ci<li><a href="#immediatehasref"><code>immediate.hasRef()</code></a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#immediateref"><code>immediate.ref()</code></a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#immediateunref"><code>immediate.unref()</code></a></li> 1301cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#immediatesymboldispose"><code>immediate[Symbol.dispose]()</code></a></span></li> 1311cb0ef41Sopenharmony_ci</ul> 1321cb0ef41Sopenharmony_ci</li> 1331cb0ef41Sopenharmony_ci<li><a href="#class-timeout">Class: <code>Timeout</code></a> 1341cb0ef41Sopenharmony_ci<ul> 1351cb0ef41Sopenharmony_ci<li><span class="stability_3"><a href="#timeoutclose"><code>timeout.close()</code></a></span></li> 1361cb0ef41Sopenharmony_ci<li><a href="#timeouthasref"><code>timeout.hasRef()</code></a></li> 1371cb0ef41Sopenharmony_ci<li><a href="#timeoutref"><code>timeout.ref()</code></a></li> 1381cb0ef41Sopenharmony_ci<li><a href="#timeoutrefresh"><code>timeout.refresh()</code></a></li> 1391cb0ef41Sopenharmony_ci<li><a href="#timeoutunref"><code>timeout.unref()</code></a></li> 1401cb0ef41Sopenharmony_ci<li><a href="#timeoutsymboltoprimitive"><code>timeout[Symbol.toPrimitive]()</code></a></li> 1411cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timeoutsymboldispose"><code>timeout[Symbol.dispose]()</code></a></span></li> 1421cb0ef41Sopenharmony_ci</ul> 1431cb0ef41Sopenharmony_ci</li> 1441cb0ef41Sopenharmony_ci<li><a href="#scheduling-timers">Scheduling timers</a> 1451cb0ef41Sopenharmony_ci<ul> 1461cb0ef41Sopenharmony_ci<li><a href="#setimmediatecallback-args"><code>setImmediate(callback[, ...args])</code></a></li> 1471cb0ef41Sopenharmony_ci<li><a href="#setintervalcallback-delay-args"><code>setInterval(callback[, delay[, ...args]])</code></a></li> 1481cb0ef41Sopenharmony_ci<li><a href="#settimeoutcallback-delay-args"><code>setTimeout(callback[, delay[, ...args]])</code></a></li> 1491cb0ef41Sopenharmony_ci</ul> 1501cb0ef41Sopenharmony_ci</li> 1511cb0ef41Sopenharmony_ci<li><a href="#cancelling-timers">Cancelling timers</a> 1521cb0ef41Sopenharmony_ci<ul> 1531cb0ef41Sopenharmony_ci<li><a href="#clearimmediateimmediate"><code>clearImmediate(immediate)</code></a></li> 1541cb0ef41Sopenharmony_ci<li><a href="#clearintervaltimeout"><code>clearInterval(timeout)</code></a></li> 1551cb0ef41Sopenharmony_ci<li><a href="#cleartimeouttimeout"><code>clearTimeout(timeout)</code></a></li> 1561cb0ef41Sopenharmony_ci</ul> 1571cb0ef41Sopenharmony_ci</li> 1581cb0ef41Sopenharmony_ci<li><a href="#timers-promises-api">Timers Promises API</a> 1591cb0ef41Sopenharmony_ci<ul> 1601cb0ef41Sopenharmony_ci<li><a href="#timerspromisessettimeoutdelay-value-options"><code>timersPromises.setTimeout([delay[, value[, options]]])</code></a></li> 1611cb0ef41Sopenharmony_ci<li><a href="#timerspromisessetimmediatevalue-options"><code>timersPromises.setImmediate([value[, options]])</code></a></li> 1621cb0ef41Sopenharmony_ci<li><a href="#timerspromisessetintervaldelay-value-options"><code>timersPromises.setInterval([delay[, value[, options]]])</code></a></li> 1631cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timerspromisesschedulerwaitdelay-options"><code>timersPromises.scheduler.wait(delay[, options])</code></a></span></li> 1641cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timerspromisesscheduleryield"><code>timersPromises.scheduler.yield()</code></a></span></li> 1651cb0ef41Sopenharmony_ci</ul> 1661cb0ef41Sopenharmony_ci</li> 1671cb0ef41Sopenharmony_ci</ul> 1681cb0ef41Sopenharmony_ci</li> 1691cb0ef41Sopenharmony_ci</ul></div></div> 1701cb0ef41Sopenharmony_ci </li> 1711cb0ef41Sopenharmony_ci 1721cb0ef41Sopenharmony_ci 1731cb0ef41Sopenharmony_ci <li class="picker-header"> 1741cb0ef41Sopenharmony_ci <a href="#"> 1751cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1761cb0ef41Sopenharmony_ci Index 1771cb0ef41Sopenharmony_ci </a> 1781cb0ef41Sopenharmony_ci 1791cb0ef41Sopenharmony_ci <div class="picker"><ul> 1801cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1821cb0ef41Sopenharmony_ci 1831cb0ef41Sopenharmony_ci <li> 1841cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1851cb0ef41Sopenharmony_ci </li> 1861cb0ef41Sopenharmony_ci </ul> 1871cb0ef41Sopenharmony_ci 1881cb0ef41Sopenharmony_ci<hr class="line"> 1891cb0ef41Sopenharmony_ci<ul> 1901cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 2141cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 2151cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 2161cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 2171cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 2181cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 2191cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 2201cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 2211cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 2221cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 2231cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 2241cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 2251cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 2261cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 2271cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 2291cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 2311cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 2321cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 2331cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 2341cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 2351cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2361cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers active">Timers</a></li> 2371cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2381cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2391cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2411cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2421cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2431cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2441cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2461cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2471cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2481cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2491cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2501cb0ef41Sopenharmony_ci</ul> 2511cb0ef41Sopenharmony_ci<hr class="line"> 2521cb0ef41Sopenharmony_ci<ul> 2531cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2541cb0ef41Sopenharmony_ci</ul></div> 2551cb0ef41Sopenharmony_ci </li> 2561cb0ef41Sopenharmony_ci 2571cb0ef41Sopenharmony_ci 2581cb0ef41Sopenharmony_ci <li class="picker-header"> 2591cb0ef41Sopenharmony_ci <a href="#"> 2601cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2611cb0ef41Sopenharmony_ci Other versions 2621cb0ef41Sopenharmony_ci </a> 2631cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/timers.html">21.x</a></li> 2641cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/timers.html">20.x <b>LTS</b></a></li> 2651cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/timers.html">19.x</a></li> 2661cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/timers.html">18.x <b>LTS</b></a></li> 2671cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/timers.html">17.x</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/timers.html">16.x</a></li> 2691cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/timers.html">15.x</a></li> 2701cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/timers.html">14.x</a></li> 2711cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/timers.html">13.x</a></li> 2721cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/timers.html">12.x</a></li> 2731cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/timers.html">11.x</a></li> 2741cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/timers.html">10.x</a></li> 2751cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/timers.html">9.x</a></li> 2761cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/timers.html">8.x</a></li> 2771cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/timers.html">7.x</a></li> 2781cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/timers.html">6.x</a></li> 2791cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/timers.html">5.x</a></li> 2801cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/timers.html">4.x</a></li> 2811cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/timers.html">0.12.x</a></li> 2821cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/timers.html">0.10.x</a></li></ol></div> 2831cb0ef41Sopenharmony_ci </li> 2841cb0ef41Sopenharmony_ci 2851cb0ef41Sopenharmony_ci <li class="picker-header"> 2861cb0ef41Sopenharmony_ci <a href="#"> 2871cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2881cb0ef41Sopenharmony_ci Options 2891cb0ef41Sopenharmony_ci </a> 2901cb0ef41Sopenharmony_ci 2911cb0ef41Sopenharmony_ci <div class="picker"> 2921cb0ef41Sopenharmony_ci <ul> 2931cb0ef41Sopenharmony_ci <li> 2941cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2951cb0ef41Sopenharmony_ci </li> 2961cb0ef41Sopenharmony_ci <li> 2971cb0ef41Sopenharmony_ci <a href="timers.json">View as JSON</a> 2981cb0ef41Sopenharmony_ci </li> 2991cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/timers.md">Edit on GitHub</a></li> 3001cb0ef41Sopenharmony_ci </ul> 3011cb0ef41Sopenharmony_ci </div> 3021cb0ef41Sopenharmony_ci </li> 3031cb0ef41Sopenharmony_ci </ul> 3041cb0ef41Sopenharmony_ci </div> 3051cb0ef41Sopenharmony_ci <hr> 3061cb0ef41Sopenharmony_ci </header> 3071cb0ef41Sopenharmony_ci 3081cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 3091cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#timers">Timers</a></span> 3101cb0ef41Sopenharmony_ci<ul> 3111cb0ef41Sopenharmony_ci<li><a href="#class-immediate">Class: <code>Immediate</code></a> 3121cb0ef41Sopenharmony_ci<ul> 3131cb0ef41Sopenharmony_ci<li><a href="#immediatehasref"><code>immediate.hasRef()</code></a></li> 3141cb0ef41Sopenharmony_ci<li><a href="#immediateref"><code>immediate.ref()</code></a></li> 3151cb0ef41Sopenharmony_ci<li><a href="#immediateunref"><code>immediate.unref()</code></a></li> 3161cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#immediatesymboldispose"><code>immediate[Symbol.dispose]()</code></a></span></li> 3171cb0ef41Sopenharmony_ci</ul> 3181cb0ef41Sopenharmony_ci</li> 3191cb0ef41Sopenharmony_ci<li><a href="#class-timeout">Class: <code>Timeout</code></a> 3201cb0ef41Sopenharmony_ci<ul> 3211cb0ef41Sopenharmony_ci<li><span class="stability_3"><a href="#timeoutclose"><code>timeout.close()</code></a></span></li> 3221cb0ef41Sopenharmony_ci<li><a href="#timeouthasref"><code>timeout.hasRef()</code></a></li> 3231cb0ef41Sopenharmony_ci<li><a href="#timeoutref"><code>timeout.ref()</code></a></li> 3241cb0ef41Sopenharmony_ci<li><a href="#timeoutrefresh"><code>timeout.refresh()</code></a></li> 3251cb0ef41Sopenharmony_ci<li><a href="#timeoutunref"><code>timeout.unref()</code></a></li> 3261cb0ef41Sopenharmony_ci<li><a href="#timeoutsymboltoprimitive"><code>timeout[Symbol.toPrimitive]()</code></a></li> 3271cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timeoutsymboldispose"><code>timeout[Symbol.dispose]()</code></a></span></li> 3281cb0ef41Sopenharmony_ci</ul> 3291cb0ef41Sopenharmony_ci</li> 3301cb0ef41Sopenharmony_ci<li><a href="#scheduling-timers">Scheduling timers</a> 3311cb0ef41Sopenharmony_ci<ul> 3321cb0ef41Sopenharmony_ci<li><a href="#setimmediatecallback-args"><code>setImmediate(callback[, ...args])</code></a></li> 3331cb0ef41Sopenharmony_ci<li><a href="#setintervalcallback-delay-args"><code>setInterval(callback[, delay[, ...args]])</code></a></li> 3341cb0ef41Sopenharmony_ci<li><a href="#settimeoutcallback-delay-args"><code>setTimeout(callback[, delay[, ...args]])</code></a></li> 3351cb0ef41Sopenharmony_ci</ul> 3361cb0ef41Sopenharmony_ci</li> 3371cb0ef41Sopenharmony_ci<li><a href="#cancelling-timers">Cancelling timers</a> 3381cb0ef41Sopenharmony_ci<ul> 3391cb0ef41Sopenharmony_ci<li><a href="#clearimmediateimmediate"><code>clearImmediate(immediate)</code></a></li> 3401cb0ef41Sopenharmony_ci<li><a href="#clearintervaltimeout"><code>clearInterval(timeout)</code></a></li> 3411cb0ef41Sopenharmony_ci<li><a href="#cleartimeouttimeout"><code>clearTimeout(timeout)</code></a></li> 3421cb0ef41Sopenharmony_ci</ul> 3431cb0ef41Sopenharmony_ci</li> 3441cb0ef41Sopenharmony_ci<li><a href="#timers-promises-api">Timers Promises API</a> 3451cb0ef41Sopenharmony_ci<ul> 3461cb0ef41Sopenharmony_ci<li><a href="#timerspromisessettimeoutdelay-value-options"><code>timersPromises.setTimeout([delay[, value[, options]]])</code></a></li> 3471cb0ef41Sopenharmony_ci<li><a href="#timerspromisessetimmediatevalue-options"><code>timersPromises.setImmediate([value[, options]])</code></a></li> 3481cb0ef41Sopenharmony_ci<li><a href="#timerspromisessetintervaldelay-value-options"><code>timersPromises.setInterval([delay[, value[, options]]])</code></a></li> 3491cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timerspromisesschedulerwaitdelay-options"><code>timersPromises.scheduler.wait(delay[, options])</code></a></span></li> 3501cb0ef41Sopenharmony_ci<li><span class="stability_1"><a href="#timerspromisesscheduleryield"><code>timersPromises.scheduler.yield()</code></a></span></li> 3511cb0ef41Sopenharmony_ci</ul> 3521cb0ef41Sopenharmony_ci</li> 3531cb0ef41Sopenharmony_ci</ul> 3541cb0ef41Sopenharmony_ci</li> 3551cb0ef41Sopenharmony_ci</ul></details> 3561cb0ef41Sopenharmony_ci 3571cb0ef41Sopenharmony_ci <div id="apicontent"> 3581cb0ef41Sopenharmony_ci <h2>Timers<span><a class="mark" href="#timers" id="timers">#</a></span><a aria-hidden="true" class="legacy" id="timers_timers"></a></h2> 3591cb0ef41Sopenharmony_ci 3601cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 3611cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/timers.js">lib/timers.js</a></p> 3621cb0ef41Sopenharmony_ci<p>The <code>timer</code> module exposes a global API for scheduling functions to 3631cb0ef41Sopenharmony_cibe called at some future period of time. Because the timer functions are 3641cb0ef41Sopenharmony_ciglobals, there is no need to call <code>require('node:timers')</code> to use the API.</p> 3651cb0ef41Sopenharmony_ci<p>The timer functions within Node.js implement a similar API as the timers API 3661cb0ef41Sopenharmony_ciprovided by Web Browsers but use a different internal implementation that is 3671cb0ef41Sopenharmony_cibuilt around the Node.js <a href="https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout">Event Loop</a>.</p> 3681cb0ef41Sopenharmony_ci<section><h3>Class: <code>Immediate</code><span><a class="mark" href="#class-immediate" id="class-immediate">#</a></span><a aria-hidden="true" class="legacy" id="timers_class_immediate"></a></h3> 3691cb0ef41Sopenharmony_ci<p>This object is created internally and is returned from <a href="#setimmediatecallback-args"><code>setImmediate()</code></a>. It 3701cb0ef41Sopenharmony_cican be passed to <a href="#clearimmediateimmediate"><code>clearImmediate()</code></a> in order to cancel the scheduled 3711cb0ef41Sopenharmony_ciactions.</p> 3721cb0ef41Sopenharmony_ci<p>By default, when an immediate is scheduled, the Node.js event loop will continue 3731cb0ef41Sopenharmony_cirunning as long as the immediate is active. The <code>Immediate</code> object returned by 3741cb0ef41Sopenharmony_ci<a href="#setimmediatecallback-args"><code>setImmediate()</code></a> exports both <code>immediate.ref()</code> and <code>immediate.unref()</code> 3751cb0ef41Sopenharmony_cifunctions that can be used to control this default behavior.</p> 3761cb0ef41Sopenharmony_ci<h4><code>immediate.hasRef()</code><span><a class="mark" href="#immediatehasref" id="immediatehasref">#</a></span><a aria-hidden="true" class="legacy" id="timers_immediate_hasref"></a></h4> 3771cb0ef41Sopenharmony_ci<div class="api_metadata"> 3781cb0ef41Sopenharmony_ci<span>Added in: v11.0.0</span> 3791cb0ef41Sopenharmony_ci</div> 3801cb0ef41Sopenharmony_ci<ul> 3811cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 3821cb0ef41Sopenharmony_ci</ul> 3831cb0ef41Sopenharmony_ci<p>If true, the <code>Immediate</code> object will keep the Node.js event loop active.</p> 3841cb0ef41Sopenharmony_ci<h4><code>immediate.ref()</code><span><a class="mark" href="#immediateref" id="immediateref">#</a></span><a aria-hidden="true" class="legacy" id="timers_immediate_ref"></a></h4> 3851cb0ef41Sopenharmony_ci<div class="api_metadata"> 3861cb0ef41Sopenharmony_ci<span>Added in: v9.7.0</span> 3871cb0ef41Sopenharmony_ci</div> 3881cb0ef41Sopenharmony_ci<ul> 3891cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-immediate" class="type"><Immediate></a> a reference to <code>immediate</code></li> 3901cb0ef41Sopenharmony_ci</ul> 3911cb0ef41Sopenharmony_ci<p>When called, requests that the Node.js event loop <em>not</em> exit so long as the 3921cb0ef41Sopenharmony_ci<code>Immediate</code> is active. Calling <code>immediate.ref()</code> multiple times will have no 3931cb0ef41Sopenharmony_cieffect.</p> 3941cb0ef41Sopenharmony_ci<p>By default, all <code>Immediate</code> objects are "ref'ed", making it normally unnecessary 3951cb0ef41Sopenharmony_cito call <code>immediate.ref()</code> unless <code>immediate.unref()</code> had been called previously.</p> 3961cb0ef41Sopenharmony_ci<h4><code>immediate.unref()</code><span><a class="mark" href="#immediateunref" id="immediateunref">#</a></span><a aria-hidden="true" class="legacy" id="timers_immediate_unref"></a></h4> 3971cb0ef41Sopenharmony_ci<div class="api_metadata"> 3981cb0ef41Sopenharmony_ci<span>Added in: v9.7.0</span> 3991cb0ef41Sopenharmony_ci</div> 4001cb0ef41Sopenharmony_ci<ul> 4011cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-immediate" class="type"><Immediate></a> a reference to <code>immediate</code></li> 4021cb0ef41Sopenharmony_ci</ul> 4031cb0ef41Sopenharmony_ci<p>When called, the active <code>Immediate</code> object will not require the Node.js event 4041cb0ef41Sopenharmony_ciloop to remain active. If there is no other activity keeping the event loop 4051cb0ef41Sopenharmony_cirunning, the process may exit before the <code>Immediate</code> object's callback is 4061cb0ef41Sopenharmony_ciinvoked. Calling <code>immediate.unref()</code> multiple times will have no effect.</p> 4071cb0ef41Sopenharmony_ci<h4><code>immediate[Symbol.dispose]()</code><span><a class="mark" href="#immediatesymboldispose" id="immediatesymboldispose">#</a></span><a aria-hidden="true" class="legacy" id="timers_immediate_symbol_dispose"></a></h4> 4081cb0ef41Sopenharmony_ci<div class="api_metadata"> 4091cb0ef41Sopenharmony_ci<span>Added in: v18.18.0</span> 4101cb0ef41Sopenharmony_ci</div> 4111cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental</div><p></p> 4121cb0ef41Sopenharmony_ci<p>Cancels the immediate. This is similar to calling <code>clearImmediate()</code>.</p> 4131cb0ef41Sopenharmony_ci</section><section><h3>Class: <code>Timeout</code><span><a class="mark" href="#class-timeout" id="class-timeout">#</a></span><a aria-hidden="true" class="legacy" id="timers_class_timeout"></a></h3> 4141cb0ef41Sopenharmony_ci<p>This object is created internally and is returned from <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a> and 4151cb0ef41Sopenharmony_ci<a href="#setintervalcallback-delay-args"><code>setInterval()</code></a>. It can be passed to either <a href="#cleartimeouttimeout"><code>clearTimeout()</code></a> or 4161cb0ef41Sopenharmony_ci<a href="#clearintervaltimeout"><code>clearInterval()</code></a> in order to cancel the scheduled actions.</p> 4171cb0ef41Sopenharmony_ci<p>By default, when a timer is scheduled using either <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a> or 4181cb0ef41Sopenharmony_ci<a href="#setintervalcallback-delay-args"><code>setInterval()</code></a>, the Node.js event loop will continue running as long as the 4191cb0ef41Sopenharmony_citimer is active. Each of the <code>Timeout</code> objects returned by these functions 4201cb0ef41Sopenharmony_ciexport both <code>timeout.ref()</code> and <code>timeout.unref()</code> functions that can be used to 4211cb0ef41Sopenharmony_cicontrol this default behavior.</p> 4221cb0ef41Sopenharmony_ci<h4><code>timeout.close()</code><span><a class="mark" href="#timeoutclose" id="timeoutclose">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_close"></a></h4> 4231cb0ef41Sopenharmony_ci<div class="api_metadata"> 4241cb0ef41Sopenharmony_ci<span>Added in: v0.9.1</span> 4251cb0ef41Sopenharmony_ci</div> 4261cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_3"><a href="documentation.html#stability-index">Stability: 3</a> - Legacy: Use <a href="#cleartimeouttimeout"><code>clearTimeout()</code></a> instead.</div><p></p> 4271cb0ef41Sopenharmony_ci<ul> 4281cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> a reference to <code>timeout</code></li> 4291cb0ef41Sopenharmony_ci</ul> 4301cb0ef41Sopenharmony_ci<p>Cancels the timeout.</p> 4311cb0ef41Sopenharmony_ci<h4><code>timeout.hasRef()</code><span><a class="mark" href="#timeouthasref" id="timeouthasref">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_hasref"></a></h4> 4321cb0ef41Sopenharmony_ci<div class="api_metadata"> 4331cb0ef41Sopenharmony_ci<span>Added in: v11.0.0</span> 4341cb0ef41Sopenharmony_ci</div> 4351cb0ef41Sopenharmony_ci<ul> 4361cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 4371cb0ef41Sopenharmony_ci</ul> 4381cb0ef41Sopenharmony_ci<p>If true, the <code>Timeout</code> object will keep the Node.js event loop active.</p> 4391cb0ef41Sopenharmony_ci<h4><code>timeout.ref()</code><span><a class="mark" href="#timeoutref" id="timeoutref">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_ref"></a></h4> 4401cb0ef41Sopenharmony_ci<div class="api_metadata"> 4411cb0ef41Sopenharmony_ci<span>Added in: v0.9.1</span> 4421cb0ef41Sopenharmony_ci</div> 4431cb0ef41Sopenharmony_ci<ul> 4441cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> a reference to <code>timeout</code></li> 4451cb0ef41Sopenharmony_ci</ul> 4461cb0ef41Sopenharmony_ci<p>When called, requests that the Node.js event loop <em>not</em> exit so long as the 4471cb0ef41Sopenharmony_ci<code>Timeout</code> is active. Calling <code>timeout.ref()</code> multiple times will have no effect.</p> 4481cb0ef41Sopenharmony_ci<p>By default, all <code>Timeout</code> objects are "ref'ed", making it normally unnecessary 4491cb0ef41Sopenharmony_cito call <code>timeout.ref()</code> unless <code>timeout.unref()</code> had been called previously.</p> 4501cb0ef41Sopenharmony_ci<h4><code>timeout.refresh()</code><span><a class="mark" href="#timeoutrefresh" id="timeoutrefresh">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_refresh"></a></h4> 4511cb0ef41Sopenharmony_ci<div class="api_metadata"> 4521cb0ef41Sopenharmony_ci<span>Added in: v10.2.0</span> 4531cb0ef41Sopenharmony_ci</div> 4541cb0ef41Sopenharmony_ci<ul> 4551cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> a reference to <code>timeout</code></li> 4561cb0ef41Sopenharmony_ci</ul> 4571cb0ef41Sopenharmony_ci<p>Sets the timer's start time to the current time, and reschedules the timer to 4581cb0ef41Sopenharmony_cicall its callback at the previously specified duration adjusted to the current 4591cb0ef41Sopenharmony_citime. This is useful for refreshing a timer without allocating a new 4601cb0ef41Sopenharmony_ciJavaScript object.</p> 4611cb0ef41Sopenharmony_ci<p>Using this on a timer that has already called its callback will reactivate the 4621cb0ef41Sopenharmony_citimer.</p> 4631cb0ef41Sopenharmony_ci<h4><code>timeout.unref()</code><span><a class="mark" href="#timeoutunref" id="timeoutunref">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_unref"></a></h4> 4641cb0ef41Sopenharmony_ci<div class="api_metadata"> 4651cb0ef41Sopenharmony_ci<span>Added in: v0.9.1</span> 4661cb0ef41Sopenharmony_ci</div> 4671cb0ef41Sopenharmony_ci<ul> 4681cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> a reference to <code>timeout</code></li> 4691cb0ef41Sopenharmony_ci</ul> 4701cb0ef41Sopenharmony_ci<p>When called, the active <code>Timeout</code> object will not require the Node.js event loop 4711cb0ef41Sopenharmony_cito remain active. If there is no other activity keeping the event loop running, 4721cb0ef41Sopenharmony_cithe process may exit before the <code>Timeout</code> object's callback is invoked. Calling 4731cb0ef41Sopenharmony_ci<code>timeout.unref()</code> multiple times will have no effect.</p> 4741cb0ef41Sopenharmony_ci<h4><code>timeout[Symbol.toPrimitive]()</code><span><a class="mark" href="#timeoutsymboltoprimitive" id="timeoutsymboltoprimitive">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_symbol_toprimitive"></a></h4> 4751cb0ef41Sopenharmony_ci<div class="api_metadata"> 4761cb0ef41Sopenharmony_ci<span>Added in: v14.9.0, v12.19.0</span> 4771cb0ef41Sopenharmony_ci</div> 4781cb0ef41Sopenharmony_ci<ul> 4791cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> a number that can be used to reference this <code>timeout</code></li> 4801cb0ef41Sopenharmony_ci</ul> 4811cb0ef41Sopenharmony_ci<p>Coerce a <code>Timeout</code> to a primitive. The primitive can be used to 4821cb0ef41Sopenharmony_ciclear the <code>Timeout</code>. The primitive can only be used in the 4831cb0ef41Sopenharmony_cisame thread where the timeout was created. Therefore, to use it 4841cb0ef41Sopenharmony_ciacross <a href="worker_threads.html"><code>worker_threads</code></a> it must first be passed to the correct 4851cb0ef41Sopenharmony_cithread. This allows enhanced compatibility with browser 4861cb0ef41Sopenharmony_ci<code>setTimeout()</code> and <code>setInterval()</code> implementations.</p> 4871cb0ef41Sopenharmony_ci<h4><code>timeout[Symbol.dispose]()</code><span><a class="mark" href="#timeoutsymboldispose" id="timeoutsymboldispose">#</a></span><a aria-hidden="true" class="legacy" id="timers_timeout_symbol_dispose"></a></h4> 4881cb0ef41Sopenharmony_ci<div class="api_metadata"> 4891cb0ef41Sopenharmony_ci<span>Added in: v18.18.0</span> 4901cb0ef41Sopenharmony_ci</div> 4911cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental</div><p></p> 4921cb0ef41Sopenharmony_ci<p>Cancels the timeout.</p> 4931cb0ef41Sopenharmony_ci</section><section><h3>Scheduling timers<span><a class="mark" href="#scheduling-timers" id="scheduling-timers">#</a></span><a aria-hidden="true" class="legacy" id="timers_scheduling_timers"></a></h3> 4941cb0ef41Sopenharmony_ci<p>A timer in Node.js is an internal construct that calls a given function after 4951cb0ef41Sopenharmony_cia certain period of time. When a timer's function is called varies depending on 4961cb0ef41Sopenharmony_ciwhich method was used to create the timer and what other work the Node.js 4971cb0ef41Sopenharmony_cievent loop is doing.</p> 4981cb0ef41Sopenharmony_ci<h4><code>setImmediate(callback[, ...args])</code><span><a class="mark" href="#setimmediatecallback-args" id="setimmediatecallback-args">#</a></span><a aria-hidden="true" class="legacy" id="timers_setimmediate_callback_args"></a></h4> 4991cb0ef41Sopenharmony_ci<div class="api_metadata"> 5001cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 5011cb0ef41Sopenharmony_ci<table> 5021cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 5031cb0ef41Sopenharmony_ci<tr><td>v18.0.0</td> 5041cb0ef41Sopenharmony_ci<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5051cb0ef41Sopenharmony_ci<tr><td>v0.9.1</td> 5061cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.9.1</span></p></td></tr> 5071cb0ef41Sopenharmony_ci</tbody></table> 5081cb0ef41Sopenharmony_ci</details> 5091cb0ef41Sopenharmony_ci</div> 5101cb0ef41Sopenharmony_ci<ul> 5111cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function to call at the end of this turn of 5121cb0ef41Sopenharmony_cithe Node.js <a href="https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout">Event Loop</a></li> 5131cb0ef41Sopenharmony_ci<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> Optional arguments to pass when the <code>callback</code> is called.</li> 5141cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-immediate" class="type"><Immediate></a> for use with <a href="#clearimmediateimmediate"><code>clearImmediate()</code></a></li> 5151cb0ef41Sopenharmony_ci</ul> 5161cb0ef41Sopenharmony_ci<p>Schedules the "immediate" execution of the <code>callback</code> after I/O events' 5171cb0ef41Sopenharmony_cicallbacks.</p> 5181cb0ef41Sopenharmony_ci<p>When multiple calls to <code>setImmediate()</code> are made, the <code>callback</code> functions are 5191cb0ef41Sopenharmony_ciqueued for execution in the order in which they are created. The entire callback 5201cb0ef41Sopenharmony_ciqueue is processed every event loop iteration. If an immediate timer is queued 5211cb0ef41Sopenharmony_cifrom inside an executing callback, that timer will not be triggered until the 5221cb0ef41Sopenharmony_cinext event loop iteration.</p> 5231cb0ef41Sopenharmony_ci<p>If <code>callback</code> is not a function, a <a href="errors.html#class-typeerror"><code>TypeError</code></a> will be thrown.</p> 5241cb0ef41Sopenharmony_ci<p>This method has a custom variant for promises that is available using 5251cb0ef41Sopenharmony_ci<a href="#timerspromisessetimmediatevalue-options"><code>timersPromises.setImmediate()</code></a>.</p> 5261cb0ef41Sopenharmony_ci<h4><code>setInterval(callback[, delay[, ...args]])</code><span><a class="mark" href="#setintervalcallback-delay-args" id="setintervalcallback-delay-args">#</a></span><a aria-hidden="true" class="legacy" id="timers_setinterval_callback_delay_args"></a></h4> 5271cb0ef41Sopenharmony_ci<div class="api_metadata"> 5281cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 5291cb0ef41Sopenharmony_ci<table> 5301cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 5311cb0ef41Sopenharmony_ci<tr><td>v18.0.0</td> 5321cb0ef41Sopenharmony_ci<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5331cb0ef41Sopenharmony_ci<tr><td>v0.0.1</td> 5341cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.0.1</span></p></td></tr> 5351cb0ef41Sopenharmony_ci</tbody></table> 5361cb0ef41Sopenharmony_ci</details> 5371cb0ef41Sopenharmony_ci</div> 5381cb0ef41Sopenharmony_ci<ul> 5391cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function to call when the timer elapses.</li> 5401cb0ef41Sopenharmony_ci<li><code>delay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds to wait before calling the 5411cb0ef41Sopenharmony_ci<code>callback</code>. <strong>Default:</strong> <code>1</code>.</li> 5421cb0ef41Sopenharmony_ci<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> Optional arguments to pass when the <code>callback</code> is called.</li> 5431cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> for use with <a href="#clearintervaltimeout"><code>clearInterval()</code></a></li> 5441cb0ef41Sopenharmony_ci</ul> 5451cb0ef41Sopenharmony_ci<p>Schedules repeated execution of <code>callback</code> every <code>delay</code> milliseconds.</p> 5461cb0ef41Sopenharmony_ci<p>When <code>delay</code> is larger than <code>2147483647</code> or less than <code>1</code>, the <code>delay</code> will be 5471cb0ef41Sopenharmony_ciset to <code>1</code>. Non-integer delays are truncated to an integer.</p> 5481cb0ef41Sopenharmony_ci<p>If <code>callback</code> is not a function, a <a href="errors.html#class-typeerror"><code>TypeError</code></a> will be thrown.</p> 5491cb0ef41Sopenharmony_ci<p>This method has a custom variant for promises that is available using 5501cb0ef41Sopenharmony_ci<a href="#timerspromisessetintervaldelay-value-options"><code>timersPromises.setInterval()</code></a>.</p> 5511cb0ef41Sopenharmony_ci<h4><code>setTimeout(callback[, delay[, ...args]])</code><span><a class="mark" href="#settimeoutcallback-delay-args" id="settimeoutcallback-delay-args">#</a></span><a aria-hidden="true" class="legacy" id="timers_settimeout_callback_delay_args"></a></h4> 5521cb0ef41Sopenharmony_ci<div class="api_metadata"> 5531cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 5541cb0ef41Sopenharmony_ci<table> 5551cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 5561cb0ef41Sopenharmony_ci<tr><td>v18.0.0</td> 5571cb0ef41Sopenharmony_ci<td><p>Passing an invalid callback to the <code>callback</code> argument now throws <code>ERR_INVALID_ARG_TYPE</code> instead of <code>ERR_INVALID_CALLBACK</code>.</p></td></tr> 5581cb0ef41Sopenharmony_ci<tr><td>v0.0.1</td> 5591cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.0.1</span></p></td></tr> 5601cb0ef41Sopenharmony_ci</tbody></table> 5611cb0ef41Sopenharmony_ci</details> 5621cb0ef41Sopenharmony_ci</div> 5631cb0ef41Sopenharmony_ci<ul> 5641cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function to call when the timer elapses.</li> 5651cb0ef41Sopenharmony_ci<li><code>delay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds to wait before calling the 5661cb0ef41Sopenharmony_ci<code>callback</code>. <strong>Default:</strong> <code>1</code>.</li> 5671cb0ef41Sopenharmony_ci<li><code>...args</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> Optional arguments to pass when the <code>callback</code> is called.</li> 5681cb0ef41Sopenharmony_ci<li>Returns: <a href="timers.html#class-timeout" class="type"><Timeout></a> for use with <a href="#cleartimeouttimeout"><code>clearTimeout()</code></a></li> 5691cb0ef41Sopenharmony_ci</ul> 5701cb0ef41Sopenharmony_ci<p>Schedules execution of a one-time <code>callback</code> after <code>delay</code> milliseconds.</p> 5711cb0ef41Sopenharmony_ci<p>The <code>callback</code> will likely not be invoked in precisely <code>delay</code> milliseconds. 5721cb0ef41Sopenharmony_ciNode.js makes no guarantees about the exact timing of when callbacks will fire, 5731cb0ef41Sopenharmony_cinor of their ordering. The callback will be called as close as possible to the 5741cb0ef41Sopenharmony_citime specified.</p> 5751cb0ef41Sopenharmony_ci<p>When <code>delay</code> is larger than <code>2147483647</code> or less than <code>1</code>, the <code>delay</code> 5761cb0ef41Sopenharmony_ciwill be set to <code>1</code>. Non-integer delays are truncated to an integer.</p> 5771cb0ef41Sopenharmony_ci<p>If <code>callback</code> is not a function, a <a href="errors.html#class-typeerror"><code>TypeError</code></a> will be thrown.</p> 5781cb0ef41Sopenharmony_ci<p>This method has a custom variant for promises that is available using 5791cb0ef41Sopenharmony_ci<a href="#timerspromisessettimeoutdelay-value-options"><code>timersPromises.setTimeout()</code></a>.</p> 5801cb0ef41Sopenharmony_ci</section><section><h3>Cancelling timers<span><a class="mark" href="#cancelling-timers" id="cancelling-timers">#</a></span><a aria-hidden="true" class="legacy" id="timers_cancelling_timers"></a></h3> 5811cb0ef41Sopenharmony_ci<p>The <a href="#setimmediatecallback-args"><code>setImmediate()</code></a>, <a href="#setintervalcallback-delay-args"><code>setInterval()</code></a>, and <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a> methods 5821cb0ef41Sopenharmony_cieach return objects that represent the scheduled timers. These can be used to 5831cb0ef41Sopenharmony_cicancel the timer and prevent it from triggering.</p> 5841cb0ef41Sopenharmony_ci<p>For the promisified variants of <a href="#setimmediatecallback-args"><code>setImmediate()</code></a> and <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a>, 5851cb0ef41Sopenharmony_cian <a href="globals.html#class-abortcontroller"><code>AbortController</code></a> may be used to cancel the timer. When canceled, the 5861cb0ef41Sopenharmony_cireturned Promises will be rejected with an <code>'AbortError'</code>.</p> 5871cb0ef41Sopenharmony_ci<p>For <code>setImmediate()</code>:</p> 5881cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-attr">setImmediate</span>: setImmediatePromise } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>); 5891cb0ef41Sopenharmony_ci 5901cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> ac = <span class="hljs-keyword">new</span> <span class="hljs-title class_">AbortController</span>(); 5911cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> signal = ac.<span class="hljs-property">signal</span>; 5921cb0ef41Sopenharmony_ci 5931cb0ef41Sopenharmony_ci<span class="hljs-title function_">setImmediatePromise</span>(<span class="hljs-string">'foobar'</span>, { signal }) 5941cb0ef41Sopenharmony_ci .<span class="hljs-title function_">then</span>(<span class="hljs-variable language_">console</span>.<span class="hljs-property">log</span>) 5951cb0ef41Sopenharmony_ci .<span class="hljs-title function_">catch</span>(<span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 5961cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (err.<span class="hljs-property">name</span> === <span class="hljs-string">'AbortError'</span>) 5971cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'The immediate was aborted'</span>); 5981cb0ef41Sopenharmony_ci }); 5991cb0ef41Sopenharmony_ci 6001cb0ef41Sopenharmony_ciac.<span class="hljs-title function_">abort</span>();</code> <button class="copy-button">copy</button></pre> 6011cb0ef41Sopenharmony_ci<p>For <code>setTimeout()</code>:</p> 6021cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> { <span class="hljs-attr">setTimeout</span>: setTimeoutPromise } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>); 6031cb0ef41Sopenharmony_ci 6041cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> ac = <span class="hljs-keyword">new</span> <span class="hljs-title class_">AbortController</span>(); 6051cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> signal = ac.<span class="hljs-property">signal</span>; 6061cb0ef41Sopenharmony_ci 6071cb0ef41Sopenharmony_cisetTimeoutPromise(<span class="hljs-number">1000</span>, <span class="hljs-string">'foobar'</span>, { signal }) 6081cb0ef41Sopenharmony_ci .<span class="hljs-title function_">then</span>(<span class="hljs-variable language_">console</span>.<span class="hljs-property">log</span>) 6091cb0ef41Sopenharmony_ci .<span class="hljs-title function_">catch</span>(<span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 6101cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> (err.<span class="hljs-property">name</span> === <span class="hljs-string">'AbortError'</span>) 6111cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(<span class="hljs-string">'The timeout was aborted'</span>); 6121cb0ef41Sopenharmony_ci }); 6131cb0ef41Sopenharmony_ci 6141cb0ef41Sopenharmony_ciac.<span class="hljs-title function_">abort</span>();</code> <button class="copy-button">copy</button></pre> 6151cb0ef41Sopenharmony_ci<h4><code>clearImmediate(immediate)</code><span><a class="mark" href="#clearimmediateimmediate" id="clearimmediateimmediate">#</a></span><a aria-hidden="true" class="legacy" id="timers_clearimmediate_immediate"></a></h4> 6161cb0ef41Sopenharmony_ci<div class="api_metadata"> 6171cb0ef41Sopenharmony_ci<span>Added in: v0.9.1</span> 6181cb0ef41Sopenharmony_ci</div> 6191cb0ef41Sopenharmony_ci<ul> 6201cb0ef41Sopenharmony_ci<li><code>immediate</code> <a href="timers.html#class-immediate" class="type"><Immediate></a> An <code>Immediate</code> object as returned by 6211cb0ef41Sopenharmony_ci<a href="#setimmediatecallback-args"><code>setImmediate()</code></a>.</li> 6221cb0ef41Sopenharmony_ci</ul> 6231cb0ef41Sopenharmony_ci<p>Cancels an <code>Immediate</code> object created by <a href="#setimmediatecallback-args"><code>setImmediate()</code></a>.</p> 6241cb0ef41Sopenharmony_ci<h4><code>clearInterval(timeout)</code><span><a class="mark" href="#clearintervaltimeout" id="clearintervaltimeout">#</a></span><a aria-hidden="true" class="legacy" id="timers_clearinterval_timeout"></a></h4> 6251cb0ef41Sopenharmony_ci<div class="api_metadata"> 6261cb0ef41Sopenharmony_ci<span>Added in: v0.0.1</span> 6271cb0ef41Sopenharmony_ci</div> 6281cb0ef41Sopenharmony_ci<ul> 6291cb0ef41Sopenharmony_ci<li><code>timeout</code> <a href="timers.html#class-timeout" class="type"><Timeout></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A <code>Timeout</code> object as returned by <a href="#setintervalcallback-delay-args"><code>setInterval()</code></a> 6301cb0ef41Sopenharmony_cior the <a href="#timeoutsymboltoprimitive">primitive</a> of the <code>Timeout</code> object as a string or a number.</li> 6311cb0ef41Sopenharmony_ci</ul> 6321cb0ef41Sopenharmony_ci<p>Cancels a <code>Timeout</code> object created by <a href="#setintervalcallback-delay-args"><code>setInterval()</code></a>.</p> 6331cb0ef41Sopenharmony_ci<h4><code>clearTimeout(timeout)</code><span><a class="mark" href="#cleartimeouttimeout" id="cleartimeouttimeout">#</a></span><a aria-hidden="true" class="legacy" id="timers_cleartimeout_timeout"></a></h4> 6341cb0ef41Sopenharmony_ci<div class="api_metadata"> 6351cb0ef41Sopenharmony_ci<span>Added in: v0.0.1</span> 6361cb0ef41Sopenharmony_ci</div> 6371cb0ef41Sopenharmony_ci<ul> 6381cb0ef41Sopenharmony_ci<li><code>timeout</code> <a href="timers.html#class-timeout" class="type"><Timeout></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A <code>Timeout</code> object as returned by <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a> 6391cb0ef41Sopenharmony_cior the <a href="#timeoutsymboltoprimitive">primitive</a> of the <code>Timeout</code> object as a string or a number.</li> 6401cb0ef41Sopenharmony_ci</ul> 6411cb0ef41Sopenharmony_ci<p>Cancels a <code>Timeout</code> object created by <a href="#settimeoutcallback-delay-args"><code>setTimeout()</code></a>.</p> 6421cb0ef41Sopenharmony_ci</section><section><h3>Timers Promises API<span><a class="mark" href="#timers-promises-api" id="timers-promises-api">#</a></span><a aria-hidden="true" class="legacy" id="timers_timers_promises_api"></a></h3> 6431cb0ef41Sopenharmony_ci<div class="api_metadata"> 6441cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 6451cb0ef41Sopenharmony_ci<table> 6461cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 6471cb0ef41Sopenharmony_ci<tr><td>v16.0.0</td> 6481cb0ef41Sopenharmony_ci<td><p>Graduated from experimental.</p></td></tr> 6491cb0ef41Sopenharmony_ci<tr><td>v15.0.0</td> 6501cb0ef41Sopenharmony_ci<td><p><span>Added in: v15.0.0</span></p></td></tr> 6511cb0ef41Sopenharmony_ci</tbody></table> 6521cb0ef41Sopenharmony_ci</details> 6531cb0ef41Sopenharmony_ci</div> 6541cb0ef41Sopenharmony_ci<p>The <code>timers/promises</code> API provides an alternative set of timer functions 6551cb0ef41Sopenharmony_cithat return <code>Promise</code> objects. The API is accessible via 6561cb0ef41Sopenharmony_ci<code>require('node:timers/promises')</code>.</p> 6571cb0ef41Sopenharmony_ci 6581cb0ef41Sopenharmony_ci<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 6591cb0ef41Sopenharmony_ci <span class="hljs-built_in">setTimeout</span>, 6601cb0ef41Sopenharmony_ci setImmediate, 6611cb0ef41Sopenharmony_ci <span class="hljs-built_in">setInterval</span>, 6621cb0ef41Sopenharmony_ci} <span class="hljs-keyword">from</span> <span class="hljs-string">'timers/promises'</span>;</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 6631cb0ef41Sopenharmony_ci <span class="hljs-built_in">setTimeout</span>, 6641cb0ef41Sopenharmony_ci setImmediate, 6651cb0ef41Sopenharmony_ci <span class="hljs-built_in">setInterval</span>, 6661cb0ef41Sopenharmony_ci} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>);</code><button class="copy-button">copy</button></pre> 6671cb0ef41Sopenharmony_ci<h4><code>timersPromises.setTimeout([delay[, value[, options]]])</code><span><a class="mark" href="#timerspromisessettimeoutdelay-value-options" id="timerspromisessettimeoutdelay-value-options">#</a></span><a aria-hidden="true" class="legacy" id="timers_timerspromises_settimeout_delay_value_options"></a></h4> 6681cb0ef41Sopenharmony_ci<div class="api_metadata"> 6691cb0ef41Sopenharmony_ci<span>Added in: v15.0.0</span> 6701cb0ef41Sopenharmony_ci</div> 6711cb0ef41Sopenharmony_ci<ul> 6721cb0ef41Sopenharmony_ci<li><code>delay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds to wait before fulfilling the 6731cb0ef41Sopenharmony_cipromise. <strong>Default:</strong> <code>1</code>.</li> 6741cb0ef41Sopenharmony_ci<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> A value with which the promise is fulfilled.</li> 6751cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 6761cb0ef41Sopenharmony_ci<ul> 6771cb0ef41Sopenharmony_ci<li><code>ref</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Set to <code>false</code> to indicate that the scheduled <code>Timeout</code> 6781cb0ef41Sopenharmony_cishould not require the Node.js event loop to remain active. 6791cb0ef41Sopenharmony_ci<strong>Default:</strong> <code>true</code>.</li> 6801cb0ef41Sopenharmony_ci<li><code>signal</code> <a href="globals.html#class-abortsignal" class="type"><AbortSignal></a> An optional <code>AbortSignal</code> that can be used to 6811cb0ef41Sopenharmony_cicancel the scheduled <code>Timeout</code>.</li> 6821cb0ef41Sopenharmony_ci</ul> 6831cb0ef41Sopenharmony_ci</li> 6841cb0ef41Sopenharmony_ci</ul> 6851cb0ef41Sopenharmony_ci 6861cb0ef41Sopenharmony_ci<pre class="with-13-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 6871cb0ef41Sopenharmony_ci <span class="hljs-built_in">setTimeout</span>, 6881cb0ef41Sopenharmony_ci} <span class="hljs-keyword">from</span> <span class="hljs-string">'timers/promises'</span>; 6891cb0ef41Sopenharmony_ci 6901cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> res = <span class="hljs-keyword">await</span> <span class="hljs-built_in">setTimeout</span>(<span class="hljs-number">100</span>, <span class="hljs-string">'result'</span>); 6911cb0ef41Sopenharmony_ci 6921cb0ef41Sopenharmony_ci<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(res); <span class="hljs-comment">// Prints 'result'</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 6931cb0ef41Sopenharmony_ci <span class="hljs-built_in">setTimeout</span>, 6941cb0ef41Sopenharmony_ci} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>); 6951cb0ef41Sopenharmony_ci 6961cb0ef41Sopenharmony_ci<span class="hljs-built_in">setTimeout</span>(<span class="hljs-number">100</span>, <span class="hljs-string">'result'</span>).<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 6971cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(res); <span class="hljs-comment">// Prints 'result'</span> 6981cb0ef41Sopenharmony_ci});</code><button class="copy-button">copy</button></pre> 6991cb0ef41Sopenharmony_ci<h4><code>timersPromises.setImmediate([value[, options]])</code><span><a class="mark" href="#timerspromisessetimmediatevalue-options" id="timerspromisessetimmediatevalue-options">#</a></span><a aria-hidden="true" class="legacy" id="timers_timerspromises_setimmediate_value_options"></a></h4> 7001cb0ef41Sopenharmony_ci<div class="api_metadata"> 7011cb0ef41Sopenharmony_ci<span>Added in: v15.0.0</span> 7021cb0ef41Sopenharmony_ci</div> 7031cb0ef41Sopenharmony_ci<ul> 7041cb0ef41Sopenharmony_ci<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> A value with which the promise is fulfilled.</li> 7051cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 7061cb0ef41Sopenharmony_ci<ul> 7071cb0ef41Sopenharmony_ci<li><code>ref</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Set to <code>false</code> to indicate that the scheduled <code>Immediate</code> 7081cb0ef41Sopenharmony_cishould not require the Node.js event loop to remain active. 7091cb0ef41Sopenharmony_ci<strong>Default:</strong> <code>true</code>.</li> 7101cb0ef41Sopenharmony_ci<li><code>signal</code> <a href="globals.html#class-abortsignal" class="type"><AbortSignal></a> An optional <code>AbortSignal</code> that can be used to 7111cb0ef41Sopenharmony_cicancel the scheduled <code>Immediate</code>.</li> 7121cb0ef41Sopenharmony_ci</ul> 7131cb0ef41Sopenharmony_ci</li> 7141cb0ef41Sopenharmony_ci</ul> 7151cb0ef41Sopenharmony_ci 7161cb0ef41Sopenharmony_ci<pre class="with-15-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 7171cb0ef41Sopenharmony_ci setImmediate, 7181cb0ef41Sopenharmony_ci} <span class="hljs-keyword">from</span> <span class="hljs-string">'timers/promises'</span>; 7191cb0ef41Sopenharmony_ci 7201cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> res = <span class="hljs-keyword">await</span> <span class="hljs-title function_">setImmediate</span>(<span class="hljs-string">'result'</span>); 7211cb0ef41Sopenharmony_ci 7221cb0ef41Sopenharmony_ci<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(res); <span class="hljs-comment">// Prints 'result'</span></code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 7231cb0ef41Sopenharmony_ci setImmediate, 7241cb0ef41Sopenharmony_ci} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>); 7251cb0ef41Sopenharmony_ci 7261cb0ef41Sopenharmony_ci<span class="hljs-title function_">setImmediate</span>(<span class="hljs-string">'result'</span>).<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">res</span>) =></span> { 7271cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(res); <span class="hljs-comment">// Prints 'result'</span> 7281cb0ef41Sopenharmony_ci});</code><button class="copy-button">copy</button></pre> 7291cb0ef41Sopenharmony_ci<h4><code>timersPromises.setInterval([delay[, value[, options]]])</code><span><a class="mark" href="#timerspromisessetintervaldelay-value-options" id="timerspromisessetintervaldelay-value-options">#</a></span><a aria-hidden="true" class="legacy" id="timers_timerspromises_setinterval_delay_value_options"></a></h4> 7301cb0ef41Sopenharmony_ci<div class="api_metadata"> 7311cb0ef41Sopenharmony_ci<span>Added in: v15.9.0</span> 7321cb0ef41Sopenharmony_ci</div> 7331cb0ef41Sopenharmony_ci<p>Returns an async iterator that generates values in an interval of <code>delay</code> ms. 7341cb0ef41Sopenharmony_ciIf <code>ref</code> is <code>true</code>, you need to call <code>next()</code> of async iterator explicitly 7351cb0ef41Sopenharmony_cior implicitly to keep the event loop alive.</p> 7361cb0ef41Sopenharmony_ci<ul> 7371cb0ef41Sopenharmony_ci<li><code>delay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds to wait between iterations. 7381cb0ef41Sopenharmony_ci<strong>Default:</strong> <code>1</code>.</li> 7391cb0ef41Sopenharmony_ci<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> A value with which the iterator returns.</li> 7401cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 7411cb0ef41Sopenharmony_ci<ul> 7421cb0ef41Sopenharmony_ci<li><code>ref</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> Set to <code>false</code> to indicate that the scheduled <code>Timeout</code> 7431cb0ef41Sopenharmony_cibetween iterations should not require the Node.js event loop to 7441cb0ef41Sopenharmony_ciremain active. 7451cb0ef41Sopenharmony_ci<strong>Default:</strong> <code>true</code>.</li> 7461cb0ef41Sopenharmony_ci<li><code>signal</code> <a href="globals.html#class-abortsignal" class="type"><AbortSignal></a> An optional <code>AbortSignal</code> that can be used to 7471cb0ef41Sopenharmony_cicancel the scheduled <code>Timeout</code> between operations.</li> 7481cb0ef41Sopenharmony_ci</ul> 7491cb0ef41Sopenharmony_ci</li> 7501cb0ef41Sopenharmony_ci</ul> 7511cb0ef41Sopenharmony_ci 7521cb0ef41Sopenharmony_ci<pre class="with-14-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-keyword">import</span> { 7531cb0ef41Sopenharmony_ci <span class="hljs-built_in">setInterval</span>, 7541cb0ef41Sopenharmony_ci} <span class="hljs-keyword">from</span> <span class="hljs-string">'timers/promises'</span>; 7551cb0ef41Sopenharmony_ci 7561cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> interval = <span class="hljs-number">100</span>; 7571cb0ef41Sopenharmony_ci<span class="hljs-keyword">for</span> <span class="hljs-keyword">await</span> (<span class="hljs-keyword">const</span> startTime <span class="hljs-keyword">of</span> <span class="hljs-built_in">setInterval</span>(interval, <span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>())) { 7581cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> now = <span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>(); 7591cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(now); 7601cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> ((now - startTime) > <span class="hljs-number">1000</span>) 7611cb0ef41Sopenharmony_ci <span class="hljs-keyword">break</span>; 7621cb0ef41Sopenharmony_ci} 7631cb0ef41Sopenharmony_ci<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>());</code><code class="language-js cjs"><span class="hljs-keyword">const</span> { 7641cb0ef41Sopenharmony_ci <span class="hljs-built_in">setInterval</span>, 7651cb0ef41Sopenharmony_ci} = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:timers/promises'</span>); 7661cb0ef41Sopenharmony_ci<span class="hljs-keyword">const</span> interval = <span class="hljs-number">100</span>; 7671cb0ef41Sopenharmony_ci 7681cb0ef41Sopenharmony_ci(<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) { 7691cb0ef41Sopenharmony_ci <span class="hljs-keyword">for</span> <span class="hljs-keyword">await</span> (<span class="hljs-keyword">const</span> startTime <span class="hljs-keyword">of</span> <span class="hljs-built_in">setInterval</span>(interval, <span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>())) { 7701cb0ef41Sopenharmony_ci <span class="hljs-keyword">const</span> now = <span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>(); 7711cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(now); 7721cb0ef41Sopenharmony_ci <span class="hljs-keyword">if</span> ((now - startTime) > <span class="hljs-number">1000</span>) 7731cb0ef41Sopenharmony_ci <span class="hljs-keyword">break</span>; 7741cb0ef41Sopenharmony_ci } 7751cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">Date</span>.<span class="hljs-title function_">now</span>()); 7761cb0ef41Sopenharmony_ci})();</code><button class="copy-button">copy</button></pre> 7771cb0ef41Sopenharmony_ci<h4><code>timersPromises.scheduler.wait(delay[, options])</code><span><a class="mark" href="#timerspromisesschedulerwaitdelay-options" id="timerspromisesschedulerwaitdelay-options">#</a></span><a aria-hidden="true" class="legacy" id="timers_timerspromises_scheduler_wait_delay_options"></a></h4> 7781cb0ef41Sopenharmony_ci<div class="api_metadata"> 7791cb0ef41Sopenharmony_ci<span>Added in: v17.3.0, v16.14.0</span> 7801cb0ef41Sopenharmony_ci</div> 7811cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental</div><p></p> 7821cb0ef41Sopenharmony_ci<ul> 7831cb0ef41Sopenharmony_ci<li><code>delay</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The number of milliseconds to wait before resolving the 7841cb0ef41Sopenharmony_cipromise.</li> 7851cb0ef41Sopenharmony_ci<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 7861cb0ef41Sopenharmony_ci<ul> 7871cb0ef41Sopenharmony_ci<li><code>signal</code> <a href="globals.html#class-abortsignal" class="type"><AbortSignal></a> An optional <code>AbortSignal</code> that can be used to 7881cb0ef41Sopenharmony_cicancel waiting.</li> 7891cb0ef41Sopenharmony_ci</ul> 7901cb0ef41Sopenharmony_ci</li> 7911cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="type"><Promise></a></li> 7921cb0ef41Sopenharmony_ci</ul> 7931cb0ef41Sopenharmony_ci<p>An experimental API defined by the <a href="https://github.com/WICG/scheduling-apis">Scheduling APIs</a> draft specification 7941cb0ef41Sopenharmony_cibeing developed as a standard Web Platform API.</p> 7951cb0ef41Sopenharmony_ci<p>Calling <code>timersPromises.scheduler.wait(delay, options)</code> is roughly equivalent 7961cb0ef41Sopenharmony_cito calling <code>timersPromises.setTimeout(delay, undefined, options)</code> except that 7971cb0ef41Sopenharmony_cithe <code>ref</code> option is not supported.</p> 7981cb0ef41Sopenharmony_ci<pre><code class="language-js mjs"><span class="hljs-keyword">import</span> { scheduler } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:timers/promises'</span>; 7991cb0ef41Sopenharmony_ci 8001cb0ef41Sopenharmony_ci<span class="hljs-keyword">await</span> scheduler.<span class="hljs-title function_">wait</span>(<span class="hljs-number">1000</span>); <span class="hljs-comment">// Wait one second before continuing</span></code> <button class="copy-button">copy</button></pre> 8011cb0ef41Sopenharmony_ci<h4><code>timersPromises.scheduler.yield()</code><span><a class="mark" href="#timerspromisesscheduleryield" id="timerspromisesscheduleryield">#</a></span><a aria-hidden="true" class="legacy" id="timers_timerspromises_scheduler_yield"></a></h4> 8021cb0ef41Sopenharmony_ci<div class="api_metadata"> 8031cb0ef41Sopenharmony_ci<span>Added in: v17.3.0, v16.14.0</span> 8041cb0ef41Sopenharmony_ci</div> 8051cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental</div><p></p> 8061cb0ef41Sopenharmony_ci<ul> 8071cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="type"><Promise></a></li> 8081cb0ef41Sopenharmony_ci</ul> 8091cb0ef41Sopenharmony_ci<p>An experimental API defined by the <a href="https://github.com/WICG/scheduling-apis">Scheduling APIs</a> draft specification 8101cb0ef41Sopenharmony_cibeing developed as a standard Web Platform API.</p> 8111cb0ef41Sopenharmony_ci<p>Calling <code>timersPromises.scheduler.yield()</code> is equivalent to calling 8121cb0ef41Sopenharmony_ci<code>timersPromises.setImmediate()</code> with no arguments.</p></section> 8131cb0ef41Sopenharmony_ci <!-- API END --> 8141cb0ef41Sopenharmony_ci </div> 8151cb0ef41Sopenharmony_ci </div> 8161cb0ef41Sopenharmony_ci </div> 8171cb0ef41Sopenharmony_ci</body> 8181cb0ef41Sopenharmony_ci</html> 819