1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v18.18.2"> 7 <title>TTY | Node.js v18.18.2 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/tty.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 14</head> 15<body class="alt apidoc" id="api-section-tty"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty active">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="tty" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.18.2 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <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"/> 104 <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"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <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"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.18.2</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><span class="stability_2"><a href="#tty">TTY</a></span> 124<ul> 125<li><a href="#class-ttyreadstream">Class: <code>tty.ReadStream</code></a> 126<ul> 127<li><a href="#readstreamisraw"><code>readStream.isRaw</code></a></li> 128<li><a href="#readstreamistty"><code>readStream.isTTY</code></a></li> 129<li><a href="#readstreamsetrawmodemode"><code>readStream.setRawMode(mode)</code></a></li> 130</ul> 131</li> 132<li><a href="#class-ttywritestream">Class: <code>tty.WriteStream</code></a> 133<ul> 134<li><a href="#event-resize">Event: <code>'resize'</code></a></li> 135<li><a href="#writestreamclearlinedir-callback"><code>writeStream.clearLine(dir[, callback])</code></a></li> 136<li><a href="#writestreamclearscreendowncallback"><code>writeStream.clearScreenDown([callback])</code></a></li> 137<li><a href="#writestreamcolumns"><code>writeStream.columns</code></a></li> 138<li><a href="#writestreamcursortox-y-callback"><code>writeStream.cursorTo(x[, y][, callback])</code></a></li> 139<li><a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth([env])</code></a></li> 140<li><a href="#writestreamgetwindowsize"><code>writeStream.getWindowSize()</code></a></li> 141<li><a href="#writestreamhascolorscount-env"><code>writeStream.hasColors([count][, env])</code></a></li> 142<li><a href="#writestreamistty"><code>writeStream.isTTY</code></a></li> 143<li><a href="#writestreammovecursordx-dy-callback"><code>writeStream.moveCursor(dx, dy[, callback])</code></a></li> 144<li><a href="#writestreamrows"><code>writeStream.rows</code></a></li> 145</ul> 146</li> 147<li><a href="#ttyisattyfd"><code>tty.isatty(fd)</code></a></li> 148</ul> 149</li> 150</ul></div></div> 151 </li> 152 153 154 <li class="picker-header"> 155 <a href="#"> 156 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 157 Index 158 </a> 159 160 <div class="picker"><ul> 161<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 162<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 163 164 <li> 165 <a href="index.html">Index</a> 166 </li> 167 </ul> 168 169<hr class="line"> 170<ul> 171<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 172<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 173<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 174<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 175<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 176<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 177<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 178<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 179<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 180<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 181<li><a href="console.html" class="nav-console">Console</a></li> 182<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 183<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 184<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 185<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 186<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 187<li><a href="dns.html" class="nav-dns">DNS</a></li> 188<li><a href="domain.html" class="nav-domain">Domain</a></li> 189<li><a href="errors.html" class="nav-errors">Errors</a></li> 190<li><a href="events.html" class="nav-events">Events</a></li> 191<li><a href="fs.html" class="nav-fs">File system</a></li> 192<li><a href="globals.html" class="nav-globals">Globals</a></li> 193<li><a href="http.html" class="nav-http">HTTP</a></li> 194<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 195<li><a href="https.html" class="nav-https">HTTPS</a></li> 196<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 197<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 198<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 199<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 200<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 201<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 202<li><a href="net.html" class="nav-net">Net</a></li> 203<li><a href="os.html" class="nav-os">OS</a></li> 204<li><a href="path.html" class="nav-path">Path</a></li> 205<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 206<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 207<li><a href="process.html" class="nav-process">Process</a></li> 208<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 209<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 210<li><a href="readline.html" class="nav-readline">Readline</a></li> 211<li><a href="repl.html" class="nav-repl">REPL</a></li> 212<li><a href="report.html" class="nav-report">Report</a></li> 213<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 214<li><a href="stream.html" class="nav-stream">Stream</a></li> 215<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 216<li><a href="test.html" class="nav-test">Test runner</a></li> 217<li><a href="timers.html" class="nav-timers">Timers</a></li> 218<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 219<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 220<li><a href="tty.html" class="nav-tty active">TTY</a></li> 221<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 222<li><a href="url.html" class="nav-url">URL</a></li> 223<li><a href="util.html" class="nav-util">Utilities</a></li> 224<li><a href="v8.html" class="nav-v8">V8</a></li> 225<li><a href="vm.html" class="nav-vm">VM</a></li> 226<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 227<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 228<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 229<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 230<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 231</ul> 232<hr class="line"> 233<ul> 234<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 235</ul></div> 236 </li> 237 238 239 <li class="picker-header"> 240 <a href="#"> 241 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 242 Other versions 243 </a> 244 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v20.x/api/tty.html">20.x</a></li> 245<li><a href="https://nodejs.org/docs/latest-v19.x/api/tty.html">19.x</a></li> 246<li><a href="https://nodejs.org/docs/latest-v18.x/api/tty.html">18.x <b>LTS</b></a></li> 247<li><a href="https://nodejs.org/docs/latest-v17.x/api/tty.html">17.x</a></li> 248<li><a href="https://nodejs.org/docs/latest-v16.x/api/tty.html">16.x</a></li> 249<li><a href="https://nodejs.org/docs/latest-v15.x/api/tty.html">15.x</a></li> 250<li><a href="https://nodejs.org/docs/latest-v14.x/api/tty.html">14.x</a></li> 251<li><a href="https://nodejs.org/docs/latest-v13.x/api/tty.html">13.x</a></li> 252<li><a href="https://nodejs.org/docs/latest-v12.x/api/tty.html">12.x</a></li> 253<li><a href="https://nodejs.org/docs/latest-v11.x/api/tty.html">11.x</a></li> 254<li><a href="https://nodejs.org/docs/latest-v10.x/api/tty.html">10.x</a></li> 255<li><a href="https://nodejs.org/docs/latest-v9.x/api/tty.html">9.x</a></li> 256<li><a href="https://nodejs.org/docs/latest-v8.x/api/tty.html">8.x</a></li> 257<li><a href="https://nodejs.org/docs/latest-v7.x/api/tty.html">7.x</a></li> 258<li><a href="https://nodejs.org/docs/latest-v6.x/api/tty.html">6.x</a></li> 259<li><a href="https://nodejs.org/docs/latest-v5.x/api/tty.html">5.x</a></li> 260<li><a href="https://nodejs.org/docs/latest-v4.x/api/tty.html">4.x</a></li> 261<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/tty.html">0.12.x</a></li> 262<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/tty.html">0.10.x</a></li></ol></div> 263 </li> 264 265 <li class="picker-header"> 266 <a href="#"> 267 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 268 Options 269 </a> 270 271 <div class="picker"> 272 <ul> 273 <li> 274 <a href="all.html">View on single page</a> 275 </li> 276 <li> 277 <a href="tty.json">View as JSON</a> 278 </li> 279 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/tty.md">Edit on GitHub</a></li> 280 </ul> 281 </div> 282 </li> 283 </ul> 284 </div> 285 <hr> 286 </header> 287 288 <details id="toc" open><summary>Table of contents</summary><ul> 289<li><span class="stability_2"><a href="#tty">TTY</a></span> 290<ul> 291<li><a href="#class-ttyreadstream">Class: <code>tty.ReadStream</code></a> 292<ul> 293<li><a href="#readstreamisraw"><code>readStream.isRaw</code></a></li> 294<li><a href="#readstreamistty"><code>readStream.isTTY</code></a></li> 295<li><a href="#readstreamsetrawmodemode"><code>readStream.setRawMode(mode)</code></a></li> 296</ul> 297</li> 298<li><a href="#class-ttywritestream">Class: <code>tty.WriteStream</code></a> 299<ul> 300<li><a href="#event-resize">Event: <code>'resize'</code></a></li> 301<li><a href="#writestreamclearlinedir-callback"><code>writeStream.clearLine(dir[, callback])</code></a></li> 302<li><a href="#writestreamclearscreendowncallback"><code>writeStream.clearScreenDown([callback])</code></a></li> 303<li><a href="#writestreamcolumns"><code>writeStream.columns</code></a></li> 304<li><a href="#writestreamcursortox-y-callback"><code>writeStream.cursorTo(x[, y][, callback])</code></a></li> 305<li><a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth([env])</code></a></li> 306<li><a href="#writestreamgetwindowsize"><code>writeStream.getWindowSize()</code></a></li> 307<li><a href="#writestreamhascolorscount-env"><code>writeStream.hasColors([count][, env])</code></a></li> 308<li><a href="#writestreamistty"><code>writeStream.isTTY</code></a></li> 309<li><a href="#writestreammovecursordx-dy-callback"><code>writeStream.moveCursor(dx, dy[, callback])</code></a></li> 310<li><a href="#writestreamrows"><code>writeStream.rows</code></a></li> 311</ul> 312</li> 313<li><a href="#ttyisattyfd"><code>tty.isatty(fd)</code></a></li> 314</ul> 315</li> 316</ul></details> 317 318 <div id="apicontent"> 319 <h2>TTY<span><a class="mark" href="#tty" id="tty">#</a></span><a aria-hidden="true" class="legacy" id="tty_tty"></a></h2> 320 321<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 322<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.18.2/lib/tty.js">lib/tty.js</a></p> 323<p>The <code>node:tty</code> module provides the <code>tty.ReadStream</code> and <code>tty.WriteStream</code> 324classes. In most cases, it will not be necessary or possible to use this module 325directly. However, it can be accessed using:</p> 326<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> 327<p>When Node.js detects that it is being run with a text terminal ("TTY") 328attached, <a href="process.html#processstdin"><code>process.stdin</code></a> will, by default, be initialized as an instance of 329<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 330default, be instances of <code>tty.WriteStream</code>. The preferred method of determining 331whether Node.js is being run within a TTY context is to check that the value of 332the <code>process.stdout.isTTY</code> property is <code>true</code>:</p> 333<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> 334true 335<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> 336false</code> <button class="copy-button">copy</button></pre> 337<p>In most cases, there should be little to no reason for an application to 338manually create instances of the <code>tty.ReadStream</code> and <code>tty.WriteStream</code> 339classes.</p> 340<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> 341<div class="api_metadata"> 342<span>Added in: v0.5.8</span> 343</div> 344<ul> 345<li>Extends: <a href="net.html#class-netsocket" class="type"><net.Socket></a></li> 346</ul> 347<p>Represents the readable side of a TTY. In normal circumstances 348<a href="process.html#processstdin"><code>process.stdin</code></a> will be the only <code>tty.ReadStream</code> instance in a Node.js 349process and there should be no reason to create additional instances.</p> 350<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> 351<div class="api_metadata"> 352<span>Added in: v0.7.7</span> 353</div> 354<p>A <code>boolean</code> that is <code>true</code> if the TTY is currently configured to operate as a 355raw device.</p> 356<p>This flag is always <code>false</code> when a process starts, even if the terminal is 357operating in raw mode. Its value will change with subsequent calls to 358<code>setRawMode</code>.</p> 359<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> 360<div class="api_metadata"> 361<span>Added in: v0.5.8</span> 362</div> 363<p>A <code>boolean</code> that is always <code>true</code> for <code>tty.ReadStream</code> instances.</p> 364<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> 365<div class="api_metadata"> 366<span>Added in: v0.7.7</span> 367</div> 368<ul> 369<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 370raw device. If <code>false</code>, configures the <code>tty.ReadStream</code> to operate in its 371default mode. The <code>readStream.isRaw</code> property will be set to the resulting 372mode.</li> 373<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> 374</ul> 375<p>Allows configuration of <code>tty.ReadStream</code> so that it operates as a raw device.</p> 376<p>When in raw mode, input is always available character-by-character, not 377including modifiers. Additionally, all special processing of characters by the 378terminal is disabled, including echoing input 379characters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a <code>SIGINT</code> when 380in this mode.</p> 381</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> 382<div class="api_metadata"> 383<span>Added in: v0.5.8</span> 384</div> 385<ul> 386<li>Extends: <a href="net.html#class-netsocket" class="type"><net.Socket></a></li> 387</ul> 388<p>Represents the writable side of a TTY. In normal circumstances, 389<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 390<code>tty.WriteStream</code> instances created for a Node.js process and there 391should be no reason to create additional instances.</p> 392<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> 393<div class="api_metadata"> 394<span>Added in: v0.7.7</span> 395</div> 396<p>The <code>'resize'</code> event is emitted whenever either of the <code>writeStream.columns</code> 397or <code>writeStream.rows</code> properties have changed. No arguments are passed to the 398listener callback when called.</p> 399<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> { 400 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'screen size has changed!'</span>); 401 <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>); 402});</code> <button class="copy-button">copy</button></pre> 403<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> 404<div class="api_metadata"> 405<details class="changelog"><summary>History</summary> 406<table> 407<tbody><tr><th>Version</th><th>Changes</th></tr> 408<tr><td>v12.7.0</td> 409<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 410<tr><td>v0.7.7</td> 411<td><p><span>Added in: v0.7.7</span></p></td></tr> 412</tbody></table> 413</details> 414</div> 415<ul> 416<li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> 417<ul> 418<li><code>-1</code>: to the left from cursor</li> 419<li><code>1</code>: to the right from cursor</li> 420<li><code>0</code>: the entire line</li> 421</ul> 422</li> 423<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> 424<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 425for the <code>'drain'</code> event to be emitted before continuing to write additional 426data; otherwise <code>true</code>.</li> 427</ul> 428<p><code>writeStream.clearLine()</code> clears the current line of this <code>WriteStream</code> in a 429direction identified by <code>dir</code>.</p> 430<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> 431<div class="api_metadata"> 432<details class="changelog"><summary>History</summary> 433<table> 434<tbody><tr><th>Version</th><th>Changes</th></tr> 435<tr><td>v12.7.0</td> 436<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 437<tr><td>v0.7.7</td> 438<td><p><span>Added in: v0.7.7</span></p></td></tr> 439</tbody></table> 440</details> 441</div> 442<ul> 443<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> 444<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 445for the <code>'drain'</code> event to be emitted before continuing to write additional 446data; otherwise <code>true</code>.</li> 447</ul> 448<p><code>writeStream.clearScreenDown()</code> clears this <code>WriteStream</code> from the current 449cursor down.</p> 450<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> 451<div class="api_metadata"> 452<span>Added in: v0.7.7</span> 453</div> 454<p>A <code>number</code> specifying the number of columns the TTY currently has. This property 455is updated whenever the <code>'resize'</code> event is emitted.</p> 456<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> 457<div class="api_metadata"> 458<details class="changelog"><summary>History</summary> 459<table> 460<tbody><tr><th>Version</th><th>Changes</th></tr> 461<tr><td>v12.7.0</td> 462<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 463<tr><td>v0.7.7</td> 464<td><p><span>Added in: v0.7.7</span></p></td></tr> 465</tbody></table> 466</details> 467</div> 468<ul> 469<li><code>x</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 470<li><code>y</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 471<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> 472<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 473for the <code>'drain'</code> event to be emitted before continuing to write additional 474data; otherwise <code>true</code>.</li> 475</ul> 476<p><code>writeStream.cursorTo()</code> moves this <code>WriteStream</code>'s cursor to the specified 477position.</p> 478<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> 479<div class="api_metadata"> 480<span>Added in: v9.9.0</span> 481</div> 482<ul> 483<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 484enables simulating the usage of a specific terminal. <strong>Default:</strong> 485<code>process.env</code>.</li> 486<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 487</ul> 488<p>Returns:</p> 489<ul> 490<li><code>1</code> for 2,</li> 491<li><code>4</code> for 16,</li> 492<li><code>8</code> for 256,</li> 493<li><code>24</code> for 16,777,216 colors supported.</li> 494</ul> 495<p>Use this to determine what colors the terminal supports. Due to the nature of 496colors in terminals it is possible to either have false positives or false 497negatives. It depends on process information and the environment variables that 498may lie about what terminal is used. 499It is possible to pass in an <code>env</code> object to simulate the usage of a specific 500terminal. This can be useful to check how specific environment settings behave.</p> 501<p>To enforce a specific color support, use one of the below environment settings.</p> 502<ul> 503<li>2 colors: <code>FORCE_COLOR = 0</code> (Disables colors)</li> 504<li>16 colors: <code>FORCE_COLOR = 1</code></li> 505<li>256 colors: <code>FORCE_COLOR = 2</code></li> 506<li>16,777,216 colors: <code>FORCE_COLOR = 3</code></li> 507</ul> 508<p>Disabling color support is also possible by using the <code>NO_COLOR</code> and 509<code>NODE_DISABLE_COLORS</code> environment variables.</p> 510<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> 511<div class="api_metadata"> 512<span>Added in: v0.7.7</span> 513</div> 514<ul> 515<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number[]></a></li> 516</ul> 517<p><code>writeStream.getWindowSize()</code> returns the size of the TTY 518corresponding to this <code>WriteStream</code>. The array is of the type 519<code>[numColumns, numRows]</code> where <code>numColumns</code> and <code>numRows</code> represent the number 520of columns and rows in the corresponding TTY.</p> 521<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> 522<div class="api_metadata"> 523<span>Added in: v11.13.0, v10.16.0</span> 524</div> 525<ul> 526<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). 527<strong>Default:</strong> 16.</li> 528<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 529enables simulating the usage of a specific terminal. <strong>Default:</strong> 530<code>process.env</code>.</li> 531<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 532</ul> 533<p>Returns <code>true</code> if the <code>writeStream</code> supports at least as many colors as provided 534in <code>count</code>. Minimum support is 2 (black and white).</p> 535<p>This has the same false positives and negatives as described in 536<a href="#writestreamgetcolordepthenv"><code>writeStream.getColorDepth()</code></a>.</p> 537<pre><code class="language-js">process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>(); 538<span class="hljs-comment">// Returns true or false depending on if `stdout` supports at least 16 colors.</span> 539process.<span class="hljs-property">stdout</span>.<span class="hljs-title function_">hasColors</span>(<span class="hljs-number">256</span>); 540<span class="hljs-comment">// Returns true or false depending on if `stdout` supports at least 256 colors.</span> 541process.<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> }); 542<span class="hljs-comment">// Returns true.</span> 543process.<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> }); 544<span class="hljs-comment">// Returns false (the environment setting pretends to support 2 ** 8 colors).</span></code> <button class="copy-button">copy</button></pre> 545<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> 546<div class="api_metadata"> 547<span>Added in: v0.5.8</span> 548</div> 549<p>A <code>boolean</code> that is always <code>true</code>.</p> 550<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> 551<div class="api_metadata"> 552<details class="changelog"><summary>History</summary> 553<table> 554<tbody><tr><th>Version</th><th>Changes</th></tr> 555<tr><td>v12.7.0</td> 556<td><p>The stream's write() callback and return value are exposed.</p></td></tr> 557<tr><td>v0.7.7</td> 558<td><p><span>Added in: v0.7.7</span></p></td></tr> 559</tbody></table> 560</details> 561</div> 562<ul> 563<li><code>dx</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 564<li><code>dy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 565<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> 566<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 567for the <code>'drain'</code> event to be emitted before continuing to write additional 568data; otherwise <code>true</code>.</li> 569</ul> 570<p><code>writeStream.moveCursor()</code> moves this <code>WriteStream</code>'s cursor <em>relative</em> to its 571current position.</p> 572<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> 573<div class="api_metadata"> 574<span>Added in: v0.7.7</span> 575</div> 576<p>A <code>number</code> specifying the number of rows the TTY currently has. This property 577is updated whenever the <code>'resize'</code> event is emitted.</p> 578</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> 579<div class="api_metadata"> 580<span>Added in: v0.5.8</span> 581</div> 582<ul> 583<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> 584<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 585</ul> 586<p>The <code>tty.isatty()</code> method returns <code>true</code> if the given <code>fd</code> is associated with 587a TTY and <code>false</code> if it is not, including whenever <code>fd</code> is not a non-negative 588integer.</p></section> 589 <!-- API END --> 590 </div> 591 </div> 592 </div> 593</body> 594</html> 595