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>TTY | 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/tty.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-tty"> 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">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 active">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="tty" 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="#tty">TTY</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#class-ttyreadstream">Class: <code>tty.ReadStream</code></a> 1261cb0ef41Sopenharmony_ci<ul> 1271cb0ef41Sopenharmony_ci<li><a href="#readstreamisraw"><code>readStream.isRaw</code></a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#readstreamistty"><code>readStream.isTTY</code></a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#readstreamsetrawmodemode"><code>readStream.setRawMode(mode)</code></a></li> 1301cb0ef41Sopenharmony_ci</ul> 1311cb0ef41Sopenharmony_ci</li> 1321cb0ef41Sopenharmony_ci<li><a href="#class-ttywritestream">Class: <code>tty.WriteStream</code></a> 1331cb0ef41Sopenharmony_ci<ul> 1341cb0ef41Sopenharmony_ci<li><a href="#event-resize">Event: <code>'resize'</code></a></li> 1351cb0ef41Sopenharmony_ci<li><a href="#writestreamclearlinedir-callback"><code>writeStream.clearLine(dir[, callback])</code></a></li> 1361cb0ef41Sopenharmony_ci<li><a href="#writestreamclearscreendowncallback"><code>writeStream.clearScreenDown([callback])</code></a></li> 1371cb0ef41Sopenharmony_ci<li><a href="#writestreamcolumns"><code>writeStream.columns</code></a></li> 1381cb0ef41Sopenharmony_ci<li><a href="#writestreamcursortox-y-callback"><code>writeStream.cursorTo(x[, y][, callback])</code></a></li> 1391cb0ef41Sopenharmony_ci<li><a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth([env])</code></a></li> 1401cb0ef41Sopenharmony_ci<li><a href="#writestreamgetwindowsize"><code>writeStream.getWindowSize()</code></a></li> 1411cb0ef41Sopenharmony_ci<li><a href="#writestreamhascolorscount-env"><code>writeStream.hasColors([count][, env])</code></a></li> 1421cb0ef41Sopenharmony_ci<li><a href="#writestreamistty"><code>writeStream.isTTY</code></a></li> 1431cb0ef41Sopenharmony_ci<li><a href="#writestreammovecursordx-dy-callback"><code>writeStream.moveCursor(dx, dy[, callback])</code></a></li> 1441cb0ef41Sopenharmony_ci<li><a href="#writestreamrows"><code>writeStream.rows</code></a></li> 1451cb0ef41Sopenharmony_ci</ul> 1461cb0ef41Sopenharmony_ci</li> 1471cb0ef41Sopenharmony_ci<li><a href="#ttyisattyfd"><code>tty.isatty(fd)</code></a></li> 1481cb0ef41Sopenharmony_ci</ul> 1491cb0ef41Sopenharmony_ci</li> 1501cb0ef41Sopenharmony_ci</ul></div></div> 1511cb0ef41Sopenharmony_ci </li> 1521cb0ef41Sopenharmony_ci 1531cb0ef41Sopenharmony_ci 1541cb0ef41Sopenharmony_ci <li class="picker-header"> 1551cb0ef41Sopenharmony_ci <a href="#"> 1561cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1571cb0ef41Sopenharmony_ci Index 1581cb0ef41Sopenharmony_ci </a> 1591cb0ef41Sopenharmony_ci 1601cb0ef41Sopenharmony_ci <div class="picker"><ul> 1611cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1621cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1631cb0ef41Sopenharmony_ci 1641cb0ef41Sopenharmony_ci <li> 1651cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1661cb0ef41Sopenharmony_ci </li> 1671cb0ef41Sopenharmony_ci </ul> 1681cb0ef41Sopenharmony_ci 1691cb0ef41Sopenharmony_ci<hr class="line"> 1701cb0ef41Sopenharmony_ci<ul> 1711cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path">Path</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 2141cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 2151cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 2161cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2171cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2181cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2191cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2201cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty active">TTY</a></li> 2211cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2221cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2231cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2241cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2251cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2261cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2271cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2281cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2291cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2301cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2311cb0ef41Sopenharmony_ci</ul> 2321cb0ef41Sopenharmony_ci<hr class="line"> 2331cb0ef41Sopenharmony_ci<ul> 2341cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2351cb0ef41Sopenharmony_ci</ul></div> 2361cb0ef41Sopenharmony_ci </li> 2371cb0ef41Sopenharmony_ci 2381cb0ef41Sopenharmony_ci 2391cb0ef41Sopenharmony_ci <li class="picker-header"> 2401cb0ef41Sopenharmony_ci <a href="#"> 2411cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2421cb0ef41Sopenharmony_ci Other versions 2431cb0ef41Sopenharmony_ci </a> 2441cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/tty.html">21.x</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/tty.html">20.x <b>LTS</b></a></li> 2461cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/tty.html">19.x</a></li> 2471cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/tty.html">18.x <b>LTS</b></a></li> 2481cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/tty.html">17.x</a></li> 2491cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/tty.html">16.x</a></li> 2501cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/tty.html">15.x</a></li> 2511cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/tty.html">14.x</a></li> 2521cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/tty.html">13.x</a></li> 2531cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/tty.html">12.x</a></li> 2541cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/tty.html">11.x</a></li> 2551cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/tty.html">10.x</a></li> 2561cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/tty.html">9.x</a></li> 2571cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/tty.html">8.x</a></li> 2581cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/tty.html">7.x</a></li> 2591cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/tty.html">6.x</a></li> 2601cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/tty.html">5.x</a></li> 2611cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/tty.html">4.x</a></li> 2621cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/tty.html">0.12.x</a></li> 2631cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/tty.html">0.10.x</a></li></ol></div> 2641cb0ef41Sopenharmony_ci </li> 2651cb0ef41Sopenharmony_ci 2661cb0ef41Sopenharmony_ci <li class="picker-header"> 2671cb0ef41Sopenharmony_ci <a href="#"> 2681cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2691cb0ef41Sopenharmony_ci Options 2701cb0ef41Sopenharmony_ci </a> 2711cb0ef41Sopenharmony_ci 2721cb0ef41Sopenharmony_ci <div class="picker"> 2731cb0ef41Sopenharmony_ci <ul> 2741cb0ef41Sopenharmony_ci <li> 2751cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2761cb0ef41Sopenharmony_ci </li> 2771cb0ef41Sopenharmony_ci <li> 2781cb0ef41Sopenharmony_ci <a href="tty.json">View as JSON</a> 2791cb0ef41Sopenharmony_ci </li> 2801cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/tty.md">Edit on GitHub</a></li> 2811cb0ef41Sopenharmony_ci </ul> 2821cb0ef41Sopenharmony_ci </div> 2831cb0ef41Sopenharmony_ci </li> 2841cb0ef41Sopenharmony_ci </ul> 2851cb0ef41Sopenharmony_ci </div> 2861cb0ef41Sopenharmony_ci <hr> 2871cb0ef41Sopenharmony_ci </header> 2881cb0ef41Sopenharmony_ci 2891cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2901cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#tty">TTY</a></span> 2911cb0ef41Sopenharmony_ci<ul> 2921cb0ef41Sopenharmony_ci<li><a href="#class-ttyreadstream">Class: <code>tty.ReadStream</code></a> 2931cb0ef41Sopenharmony_ci<ul> 2941cb0ef41Sopenharmony_ci<li><a href="#readstreamisraw"><code>readStream.isRaw</code></a></li> 2951cb0ef41Sopenharmony_ci<li><a href="#readstreamistty"><code>readStream.isTTY</code></a></li> 2961cb0ef41Sopenharmony_ci<li><a href="#readstreamsetrawmodemode"><code>readStream.setRawMode(mode)</code></a></li> 2971cb0ef41Sopenharmony_ci</ul> 2981cb0ef41Sopenharmony_ci</li> 2991cb0ef41Sopenharmony_ci<li><a href="#class-ttywritestream">Class: <code>tty.WriteStream</code></a> 3001cb0ef41Sopenharmony_ci<ul> 3011cb0ef41Sopenharmony_ci<li><a href="#event-resize">Event: <code>'resize'</code></a></li> 3021cb0ef41Sopenharmony_ci<li><a href="#writestreamclearlinedir-callback"><code>writeStream.clearLine(dir[, callback])</code></a></li> 3031cb0ef41Sopenharmony_ci<li><a href="#writestreamclearscreendowncallback"><code>writeStream.clearScreenDown([callback])</code></a></li> 3041cb0ef41Sopenharmony_ci<li><a href="#writestreamcolumns"><code>writeStream.columns</code></a></li> 3051cb0ef41Sopenharmony_ci<li><a href="#writestreamcursortox-y-callback"><code>writeStream.cursorTo(x[, y][, callback])</code></a></li> 3061cb0ef41Sopenharmony_ci<li><a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth([env])</code></a></li> 3071cb0ef41Sopenharmony_ci<li><a href="#writestreamgetwindowsize"><code>writeStream.getWindowSize()</code></a></li> 3081cb0ef41Sopenharmony_ci<li><a href="#writestreamhascolorscount-env"><code>writeStream.hasColors([count][, env])</code></a></li> 3091cb0ef41Sopenharmony_ci<li><a href="#writestreamistty"><code>writeStream.isTTY</code></a></li> 3101cb0ef41Sopenharmony_ci<li><a href="#writestreammovecursordx-dy-callback"><code>writeStream.moveCursor(dx, dy[, callback])</code></a></li> 3111cb0ef41Sopenharmony_ci<li><a href="#writestreamrows"><code>writeStream.rows</code></a></li> 3121cb0ef41Sopenharmony_ci</ul> 3131cb0ef41Sopenharmony_ci</li> 3141cb0ef41Sopenharmony_ci<li><a href="#ttyisattyfd"><code>tty.isatty(fd)</code></a></li> 3151cb0ef41Sopenharmony_ci</ul> 3161cb0ef41Sopenharmony_ci</li> 3171cb0ef41Sopenharmony_ci</ul></details> 3181cb0ef41Sopenharmony_ci 3191cb0ef41Sopenharmony_ci <div id="apicontent"> 3201cb0ef41Sopenharmony_ci <h2>TTY<span><a class="mark" href="#tty" id="tty">#</a></span><a aria-hidden="true" class="legacy" id="tty_tty"></a></h2> 3211cb0ef41Sopenharmony_ci 3221cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 3231cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/tty.js">lib/tty.js</a></p> 3241cb0ef41Sopenharmony_ci<p>The <code>node:tty</code> module provides the <code>tty.ReadStream</code> and <code>tty.WriteStream</code> 3251cb0ef41Sopenharmony_ciclasses. In most cases, it will not be necessary or possible to use this module 3261cb0ef41Sopenharmony_cidirectly. However, it can be accessed using:</p> 3271cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> tty = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:tty'</span>);</code> <button class="copy-button">copy</button></pre> 3281cb0ef41Sopenharmony_ci<p>When Node.js detects that it is being run with a text terminal ("TTY") 3291cb0ef41Sopenharmony_ciattached, <a href="process.html#processstdin"><code>process.stdin</code></a> will, by default, be initialized as an instance of 3301cb0ef41Sopenharmony_ci<code>tty.ReadStream</code> and both <a href="process.html#processstdout"><code>process.stdout</code></a> and <a href="process.html#processstderr"><code>process.stderr</code></a> will, by 3311cb0ef41Sopenharmony_cidefault, be instances of <code>tty.WriteStream</code>. The preferred method of determining 3321cb0ef41Sopenharmony_ciwhether Node.js is being run within a TTY context is to check that the value of 3331cb0ef41Sopenharmony_cithe <code>process.stdout.isTTY</code> property is <code>true</code>:</p> 3341cb0ef41Sopenharmony_ci<pre><code class="language-console"><span class="hljs-meta prompt_">$ </span><span class="language-bash">node -p -e <span class="hljs-string">"Boolean(process.stdout.isTTY)"</span></span> 3351cb0ef41Sopenharmony_citrue 3361cb0ef41Sopenharmony_ci<span class="hljs-meta prompt_">$ </span><span class="language-bash">node -p -e <span class="hljs-string">"Boolean(process.stdout.isTTY)"</span> | <span class="hljs-built_in">cat</span></span> 3371cb0ef41Sopenharmony_cifalse</code> <button class="copy-button">copy</button></pre> 3381cb0ef41Sopenharmony_ci<p>In most cases, there should be little to no reason for an application to 3391cb0ef41Sopenharmony_cimanually create instances of the <code>tty.ReadStream</code> and <code>tty.WriteStream</code> 3401cb0ef41Sopenharmony_ciclasses.</p> 3411cb0ef41Sopenharmony_ci<section><h3>Class: <code>tty.ReadStream</code><span><a class="mark" href="#class-ttyreadstream" id="class-ttyreadstream">#</a></span><a aria-hidden="true" class="legacy" id="tty_class_tty_readstream"></a></h3> 3421cb0ef41Sopenharmony_ci<div class="api_metadata"> 3431cb0ef41Sopenharmony_ci<span>Added in: v0.5.8</span> 3441cb0ef41Sopenharmony_ci</div> 3451cb0ef41Sopenharmony_ci<ul> 3461cb0ef41Sopenharmony_ci<li>Extends: <a href="net.html#class-netsocket" class="type"><net.Socket></a></li> 3471cb0ef41Sopenharmony_ci</ul> 3481cb0ef41Sopenharmony_ci<p>Represents the readable side of a TTY. In normal circumstances 3491cb0ef41Sopenharmony_ci<a href="process.html#processstdin"><code>process.stdin</code></a> will be the only <code>tty.ReadStream</code> instance in a Node.js 3501cb0ef41Sopenharmony_ciprocess and there should be no reason to create additional instances.</p> 3511cb0ef41Sopenharmony_ci<h4><code>readStream.isRaw</code><span><a class="mark" href="#readstreamisraw" id="readstreamisraw">#</a></span><a aria-hidden="true" class="legacy" id="tty_readstream_israw"></a></h4> 3521cb0ef41Sopenharmony_ci<div class="api_metadata"> 3531cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 3541cb0ef41Sopenharmony_ci</div> 3551cb0ef41Sopenharmony_ci<p>A <code>boolean</code> that is <code>true</code> if the TTY is currently configured to operate as a 3561cb0ef41Sopenharmony_ciraw device.</p> 3571cb0ef41Sopenharmony_ci<p>This flag is always <code>false</code> when a process starts, even if the terminal is 3581cb0ef41Sopenharmony_cioperating in raw mode. Its value will change with subsequent calls to 3591cb0ef41Sopenharmony_ci<code>setRawMode</code>.</p> 3601cb0ef41Sopenharmony_ci<h4><code>readStream.isTTY</code><span><a class="mark" href="#readstreamistty" id="readstreamistty">#</a></span><a aria-hidden="true" class="legacy" id="tty_readstream_istty"></a></h4> 3611cb0ef41Sopenharmony_ci<div class="api_metadata"> 3621cb0ef41Sopenharmony_ci<span>Added in: v0.5.8</span> 3631cb0ef41Sopenharmony_ci</div> 3641cb0ef41Sopenharmony_ci<p>A <code>boolean</code> that is always <code>true</code> for <code>tty.ReadStream</code> instances.</p> 3651cb0ef41Sopenharmony_ci<h4><code>readStream.setRawMode(mode)</code><span><a class="mark" href="#readstreamsetrawmodemode" id="readstreamsetrawmodemode">#</a></span><a aria-hidden="true" class="legacy" id="tty_readstream_setrawmode_mode"></a></h4> 3661cb0ef41Sopenharmony_ci<div class="api_metadata"> 3671cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 3681cb0ef41Sopenharmony_ci</div> 3691cb0ef41Sopenharmony_ci<ul> 3701cb0ef41Sopenharmony_ci<li><code>mode</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> If <code>true</code>, configures the <code>tty.ReadStream</code> to operate as a 3711cb0ef41Sopenharmony_ciraw device. If <code>false</code>, configures the <code>tty.ReadStream</code> to operate in its 3721cb0ef41Sopenharmony_cidefault mode. The <code>readStream.isRaw</code> property will be set to the resulting 3731cb0ef41Sopenharmony_cimode.</li> 3741cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this" class="type"><this></a> The read stream instance.</li> 3751cb0ef41Sopenharmony_ci</ul> 3761cb0ef41Sopenharmony_ci<p>Allows configuration of <code>tty.ReadStream</code> so that it operates as a raw device.</p> 3771cb0ef41Sopenharmony_ci<p>When in raw mode, input is always available character-by-character, not 3781cb0ef41Sopenharmony_ciincluding modifiers. Additionally, all special processing of characters by the 3791cb0ef41Sopenharmony_citerminal is disabled, including echoing input 3801cb0ef41Sopenharmony_cicharacters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a <code>SIGINT</code> when 3811cb0ef41Sopenharmony_ciin this mode.</p> 3821cb0ef41Sopenharmony_ci</section><section><h3>Class: <code>tty.WriteStream</code><span><a class="mark" href="#class-ttywritestream" id="class-ttywritestream">#</a></span><a aria-hidden="true" class="legacy" id="tty_class_tty_writestream"></a></h3> 3831cb0ef41Sopenharmony_ci<div class="api_metadata"> 3841cb0ef41Sopenharmony_ci<span>Added in: v0.5.8</span> 3851cb0ef41Sopenharmony_ci</div> 3861cb0ef41Sopenharmony_ci<ul> 3871cb0ef41Sopenharmony_ci<li>Extends: <a href="net.html#class-netsocket" class="type"><net.Socket></a></li> 3881cb0ef41Sopenharmony_ci</ul> 3891cb0ef41Sopenharmony_ci<p>Represents the writable side of a TTY. In normal circumstances, 3901cb0ef41Sopenharmony_ci<a href="process.html#processstdout"><code>process.stdout</code></a> and <a href="process.html#processstderr"><code>process.stderr</code></a> will be the only 3911cb0ef41Sopenharmony_ci<code>tty.WriteStream</code> instances created for a Node.js process and there 3921cb0ef41Sopenharmony_cishould be no reason to create additional instances.</p> 3931cb0ef41Sopenharmony_ci<h4>Event: <code>'resize'</code><span><a class="mark" href="#event-resize" id="event-resize">#</a></span><a aria-hidden="true" class="legacy" id="tty_event_resize"></a></h4> 3941cb0ef41Sopenharmony_ci<div class="api_metadata"> 3951cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 3961cb0ef41Sopenharmony_ci</div> 3971cb0ef41Sopenharmony_ci<p>The <code>'resize'</code> event is emitted whenever either of the <code>writeStream.columns</code> 3981cb0ef41Sopenharmony_cior <code>writeStream.rows</code> properties have changed. No arguments are passed to the 3991cb0ef41Sopenharmony_cilistener callback when called.</p> 4001cb0ef41Sopenharmony_ci<pre><code class="language-js">process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">on</span>(<span class="hljs-string">'resize'</span>, <span class="hljs-function">() =></span> { 4011cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'screen size has changed!'</span>); 4021cb0ef41Sopenharmony_ci <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${process.stdout.columns}</span>x<span class="hljs-subst">${process.stdout.rows}</span>`</span>); 4031cb0ef41Sopenharmony_ci});</code> <button class="copy-button">copy</button></pre> 4041cb0ef41Sopenharmony_ci<h4><code>writeStream.clearLine(dir[, callback])</code><span><a class="mark" href="#writestreamclearlinedir-callback" id="writestreamclearlinedir-callback">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_clearline_dir_callback"></a></h4> 4051cb0ef41Sopenharmony_ci<div class="api_metadata"> 4061cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4071cb0ef41Sopenharmony_ci<table> 4081cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4091cb0ef41Sopenharmony_ci<tr><td>v12.7.0</td> 4101cb0ef41Sopenharmony_ci<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 4111cb0ef41Sopenharmony_ci<tr><td>v0.7.7</td> 4121cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.7.7</span></p></td></tr> 4131cb0ef41Sopenharmony_ci</tbody></table> 4141cb0ef41Sopenharmony_ci</details> 4151cb0ef41Sopenharmony_ci</div> 4161cb0ef41Sopenharmony_ci<ul> 4171cb0ef41Sopenharmony_ci<li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 4181cb0ef41Sopenharmony_ci<ul> 4191cb0ef41Sopenharmony_ci<li><code>-1</code>: to the left from cursor</li> 4201cb0ef41Sopenharmony_ci<li><code>1</code>: to the right from cursor</li> 4211cb0ef41Sopenharmony_ci<li><code>0</code>: the entire line</li> 4221cb0ef41Sopenharmony_ci</ul> 4231cb0ef41Sopenharmony_ci</li> 4241cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Invoked once the operation completes.</li> 4251cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>false</code> if the stream wishes for the calling code to wait 4261cb0ef41Sopenharmony_cifor the <code>'drain'</code> event to be emitted before continuing to write additional 4271cb0ef41Sopenharmony_cidata; otherwise <code>true</code>.</li> 4281cb0ef41Sopenharmony_ci</ul> 4291cb0ef41Sopenharmony_ci<p><code>writeStream.clearLine()</code> clears the current line of this <code>WriteStream</code> in a 4301cb0ef41Sopenharmony_cidirection identified by <code>dir</code>.</p> 4311cb0ef41Sopenharmony_ci<h4><code>writeStream.clearScreenDown([callback])</code><span><a class="mark" href="#writestreamclearscreendowncallback" id="writestreamclearscreendowncallback">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_clearscreendown_callback"></a></h4> 4321cb0ef41Sopenharmony_ci<div class="api_metadata"> 4331cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4341cb0ef41Sopenharmony_ci<table> 4351cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4361cb0ef41Sopenharmony_ci<tr><td>v12.7.0</td> 4371cb0ef41Sopenharmony_ci<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 4381cb0ef41Sopenharmony_ci<tr><td>v0.7.7</td> 4391cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.7.7</span></p></td></tr> 4401cb0ef41Sopenharmony_ci</tbody></table> 4411cb0ef41Sopenharmony_ci</details> 4421cb0ef41Sopenharmony_ci</div> 4431cb0ef41Sopenharmony_ci<ul> 4441cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Invoked once the operation completes.</li> 4451cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>false</code> if the stream wishes for the calling code to wait 4461cb0ef41Sopenharmony_cifor the <code>'drain'</code> event to be emitted before continuing to write additional 4471cb0ef41Sopenharmony_cidata; otherwise <code>true</code>.</li> 4481cb0ef41Sopenharmony_ci</ul> 4491cb0ef41Sopenharmony_ci<p><code>writeStream.clearScreenDown()</code> clears this <code>WriteStream</code> from the current 4501cb0ef41Sopenharmony_cicursor down.</p> 4511cb0ef41Sopenharmony_ci<h4><code>writeStream.columns</code><span><a class="mark" href="#writestreamcolumns" id="writestreamcolumns">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_columns"></a></h4> 4521cb0ef41Sopenharmony_ci<div class="api_metadata"> 4531cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 4541cb0ef41Sopenharmony_ci</div> 4551cb0ef41Sopenharmony_ci<p>A <code>number</code> specifying the number of columns the TTY currently has. This property 4561cb0ef41Sopenharmony_ciis updated whenever the <code>'resize'</code> event is emitted.</p> 4571cb0ef41Sopenharmony_ci<h4><code>writeStream.cursorTo(x[, y][, callback])</code><span><a class="mark" href="#writestreamcursortox-y-callback" id="writestreamcursortox-y-callback">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_cursorto_x_y_callback"></a></h4> 4581cb0ef41Sopenharmony_ci<div class="api_metadata"> 4591cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4601cb0ef41Sopenharmony_ci<table> 4611cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4621cb0ef41Sopenharmony_ci<tr><td>v12.7.0</td> 4631cb0ef41Sopenharmony_ci<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 4641cb0ef41Sopenharmony_ci<tr><td>v0.7.7</td> 4651cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.7.7</span></p></td></tr> 4661cb0ef41Sopenharmony_ci</tbody></table> 4671cb0ef41Sopenharmony_ci</details> 4681cb0ef41Sopenharmony_ci</div> 4691cb0ef41Sopenharmony_ci<ul> 4701cb0ef41Sopenharmony_ci<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4711cb0ef41Sopenharmony_ci<li><code>y</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4721cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Invoked once the operation completes.</li> 4731cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>false</code> if the stream wishes for the calling code to wait 4741cb0ef41Sopenharmony_cifor the <code>'drain'</code> event to be emitted before continuing to write additional 4751cb0ef41Sopenharmony_cidata; otherwise <code>true</code>.</li> 4761cb0ef41Sopenharmony_ci</ul> 4771cb0ef41Sopenharmony_ci<p><code>writeStream.cursorTo()</code> moves this <code>WriteStream</code>'s cursor to the specified 4781cb0ef41Sopenharmony_ciposition.</p> 4791cb0ef41Sopenharmony_ci<h4><code>writeStream.getColorDepth([env])</code><span><a class="mark" href="#writestreamgetcolordepthenv" id="writestreamgetcolordepthenv">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_getcolordepth_env"></a></h4> 4801cb0ef41Sopenharmony_ci<div class="api_metadata"> 4811cb0ef41Sopenharmony_ci<span>Added in: v9.9.0</span> 4821cb0ef41Sopenharmony_ci</div> 4831cb0ef41Sopenharmony_ci<ul> 4841cb0ef41Sopenharmony_ci<li><code>env</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> An object containing the environment variables to check. This 4851cb0ef41Sopenharmony_cienables simulating the usage of a specific terminal. <strong>Default:</strong> 4861cb0ef41Sopenharmony_ci<code>process.env</code>.</li> 4871cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 4881cb0ef41Sopenharmony_ci</ul> 4891cb0ef41Sopenharmony_ci<p>Returns:</p> 4901cb0ef41Sopenharmony_ci<ul> 4911cb0ef41Sopenharmony_ci<li><code>1</code> for 2,</li> 4921cb0ef41Sopenharmony_ci<li><code>4</code> for 16,</li> 4931cb0ef41Sopenharmony_ci<li><code>8</code> for 256,</li> 4941cb0ef41Sopenharmony_ci<li><code>24</code> for 16,777,216 colors supported.</li> 4951cb0ef41Sopenharmony_ci</ul> 4961cb0ef41Sopenharmony_ci<p>Use this to determine what colors the terminal supports. Due to the nature of 4971cb0ef41Sopenharmony_cicolors in terminals it is possible to either have false positives or false 4981cb0ef41Sopenharmony_cinegatives. It depends on process information and the environment variables that 4991cb0ef41Sopenharmony_cimay lie about what terminal is used. 5001cb0ef41Sopenharmony_ciIt is possible to pass in an <code>env</code> object to simulate the usage of a specific 5011cb0ef41Sopenharmony_citerminal. This can be useful to check how specific environment settings behave.</p> 5021cb0ef41Sopenharmony_ci<p>To enforce a specific color support, use one of the below environment settings.</p> 5031cb0ef41Sopenharmony_ci<ul> 5041cb0ef41Sopenharmony_ci<li>2 colors: <code>FORCE_COLOR = 0</code> (Disables colors)</li> 5051cb0ef41Sopenharmony_ci<li>16 colors: <code>FORCE_COLOR = 1</code></li> 5061cb0ef41Sopenharmony_ci<li>256 colors: <code>FORCE_COLOR = 2</code></li> 5071cb0ef41Sopenharmony_ci<li>16,777,216 colors: <code>FORCE_COLOR = 3</code></li> 5081cb0ef41Sopenharmony_ci</ul> 5091cb0ef41Sopenharmony_ci<p>Disabling color support is also possible by using the <code>NO_COLOR</code> and 5101cb0ef41Sopenharmony_ci<code>NODE_DISABLE_COLORS</code> environment variables.</p> 5111cb0ef41Sopenharmony_ci<h4><code>writeStream.getWindowSize()</code><span><a class="mark" href="#writestreamgetwindowsize" id="writestreamgetwindowsize">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_getwindowsize"></a></h4> 5121cb0ef41Sopenharmony_ci<div class="api_metadata"> 5131cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 5141cb0ef41Sopenharmony_ci</div> 5151cb0ef41Sopenharmony_ci<ul> 5161cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number[]></a></li> 5171cb0ef41Sopenharmony_ci</ul> 5181cb0ef41Sopenharmony_ci<p><code>writeStream.getWindowSize()</code> returns the size of the TTY 5191cb0ef41Sopenharmony_cicorresponding to this <code>WriteStream</code>. The array is of the type 5201cb0ef41Sopenharmony_ci<code>[numColumns, numRows]</code> where <code>numColumns</code> and <code>numRows</code> represent the number 5211cb0ef41Sopenharmony_ciof columns and rows in the corresponding TTY.</p> 5221cb0ef41Sopenharmony_ci<h4><code>writeStream.hasColors([count][, env])</code><span><a class="mark" href="#writestreamhascolorscount-env" id="writestreamhascolorscount-env">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_hascolors_count_env"></a></h4> 5231cb0ef41Sopenharmony_ci<div class="api_metadata"> 5241cb0ef41Sopenharmony_ci<span>Added in: v11.13.0, v10.16.0</span> 5251cb0ef41Sopenharmony_ci</div> 5261cb0ef41Sopenharmony_ci<ul> 5271cb0ef41Sopenharmony_ci<li><code>count</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The number of colors that are requested (minimum 2). 5281cb0ef41Sopenharmony_ci<strong>Default:</strong> 16.</li> 5291cb0ef41Sopenharmony_ci<li><code>env</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> An object containing the environment variables to check. This 5301cb0ef41Sopenharmony_cienables simulating the usage of a specific terminal. <strong>Default:</strong> 5311cb0ef41Sopenharmony_ci<code>process.env</code>.</li> 5321cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 5331cb0ef41Sopenharmony_ci</ul> 5341cb0ef41Sopenharmony_ci<p>Returns <code>true</code> if the <code>writeStream</code> supports at least as many colors as provided 5351cb0ef41Sopenharmony_ciin <code>count</code>. Minimum support is 2 (black and white).</p> 5361cb0ef41Sopenharmony_ci<p>This has the same false positives and negatives as described in 5371cb0ef41Sopenharmony_ci<a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth()</code></a>.</p> 5381cb0ef41Sopenharmony_ci<pre><code class="language-js">process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>(); 5391cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns true or false depending on if `stdout` supports at least 16 colors.</span> 5401cb0ef41Sopenharmony_ciprocess.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>(<span class="hljs-number">256</span>); 5411cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns true or false depending on if `stdout` supports at least 256 colors.</span> 5421cb0ef41Sopenharmony_ciprocess.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>({ <span class="hljs-attr">TMUX</span>: <span class="hljs-string">'1'</span> }); 5431cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns true.</span> 5441cb0ef41Sopenharmony_ciprocess.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>(<span class="hljs-number">2</span> ** <span class="hljs-number">24</span>, { <span class="hljs-attr">TMUX</span>: <span class="hljs-string">'1'</span> }); 5451cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns false (the environment setting pretends to support 2 ** 8 colors).</span></code> <button class="copy-button">copy</button></pre> 5461cb0ef41Sopenharmony_ci<h4><code>writeStream.isTTY</code><span><a class="mark" href="#writestreamistty" id="writestreamistty">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_istty"></a></h4> 5471cb0ef41Sopenharmony_ci<div class="api_metadata"> 5481cb0ef41Sopenharmony_ci<span>Added in: v0.5.8</span> 5491cb0ef41Sopenharmony_ci</div> 5501cb0ef41Sopenharmony_ci<p>A <code>boolean</code> that is always <code>true</code>.</p> 5511cb0ef41Sopenharmony_ci<h4><code>writeStream.moveCursor(dx, dy[, callback])</code><span><a class="mark" href="#writestreammovecursordx-dy-callback" id="writestreammovecursordx-dy-callback">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_movecursor_dx_dy_callback"></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>v12.7.0</td> 5571cb0ef41Sopenharmony_ci<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 5581cb0ef41Sopenharmony_ci<tr><td>v0.7.7</td> 5591cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.7.7</span></p></td></tr> 5601cb0ef41Sopenharmony_ci</tbody></table> 5611cb0ef41Sopenharmony_ci</details> 5621cb0ef41Sopenharmony_ci</div> 5631cb0ef41Sopenharmony_ci<ul> 5641cb0ef41Sopenharmony_ci<li><code>dx</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 5651cb0ef41Sopenharmony_ci<li><code>dy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 5661cb0ef41Sopenharmony_ci<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> Invoked once the operation completes.</li> 5671cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>false</code> if the stream wishes for the calling code to wait 5681cb0ef41Sopenharmony_cifor the <code>'drain'</code> event to be emitted before continuing to write additional 5691cb0ef41Sopenharmony_cidata; otherwise <code>true</code>.</li> 5701cb0ef41Sopenharmony_ci</ul> 5711cb0ef41Sopenharmony_ci<p><code>writeStream.moveCursor()</code> moves this <code>WriteStream</code>'s cursor <em>relative</em> to its 5721cb0ef41Sopenharmony_cicurrent position.</p> 5731cb0ef41Sopenharmony_ci<h4><code>writeStream.rows</code><span><a class="mark" href="#writestreamrows" id="writestreamrows">#</a></span><a aria-hidden="true" class="legacy" id="tty_writestream_rows"></a></h4> 5741cb0ef41Sopenharmony_ci<div class="api_metadata"> 5751cb0ef41Sopenharmony_ci<span>Added in: v0.7.7</span> 5761cb0ef41Sopenharmony_ci</div> 5771cb0ef41Sopenharmony_ci<p>A <code>number</code> specifying the number of rows the TTY currently has. This property 5781cb0ef41Sopenharmony_ciis updated whenever the <code>'resize'</code> event is emitted.</p> 5791cb0ef41Sopenharmony_ci</section><section><h3><code>tty.isatty(fd)</code><span><a class="mark" href="#ttyisattyfd" id="ttyisattyfd">#</a></span><a aria-hidden="true" class="legacy" id="tty_tty_isatty_fd"></a></h3> 5801cb0ef41Sopenharmony_ci<div class="api_metadata"> 5811cb0ef41Sopenharmony_ci<span>Added in: v0.5.8</span> 5821cb0ef41Sopenharmony_ci</div> 5831cb0ef41Sopenharmony_ci<ul> 5841cb0ef41Sopenharmony_ci<li><code>fd</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> A numeric file descriptor</li> 5851cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 5861cb0ef41Sopenharmony_ci</ul> 5871cb0ef41Sopenharmony_ci<p>The <code>tty.isatty()</code> method returns <code>true</code> if the given <code>fd</code> is associated with 5881cb0ef41Sopenharmony_cia TTY and <code>false</code> if it is not, including whenever <code>fd</code> is not a non-negative 5891cb0ef41Sopenharmony_ciinteger.</p></section> 5901cb0ef41Sopenharmony_ci <!-- API END --> 5911cb0ef41Sopenharmony_ci </div> 5921cb0ef41Sopenharmony_ci </div> 5931cb0ef41Sopenharmony_ci </div> 5941cb0ef41Sopenharmony_ci</body> 5951cb0ef41Sopenharmony_ci</html> 596