{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.0.json","id":"tty","path":"/tty","type":"module","module":"tty","title":"TTY","introducedIn":"v0.10.0","sourceLink":{"path":"lib/tty.js","url":"https://github.com/nodejs/node/blob/HEAD/lib/tty.js"},"stability":{"index":"2","description":"Stable"},"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream`\nclasses. In most cases, it will not be necessary or possible to use this module\ndirectly. However, it can be accessed using:\n\n```js\nconst tty = require('node:tty');\n```\n\nWhen Node.js detects that it is being run with a text terminal (\"TTY\")\nattached, [`process.stdin`](process.html#processstdin) will, by default, be initialized as an instance of\n`tty.ReadStream` and both [`process.stdout`](process.html#processstdout) and [`process.stderr`](process.html#processstderr) will, by\ndefault, be instances of `tty.WriteStream`. The preferred method of determining\nwhether Node.js is being run within a TTY context is to check that the value of\nthe `process.stdout.isTTY` property is `true`:\n\n```console\n$ node -p -e \"Boolean(process.stdout.isTTY)\"\ntrue\n$ node -p -e \"Boolean(process.stdout.isTTY)\" | cat\nfalse\n```\n\nIn most cases, there should be little to no reason for an application to\nmanually create instances of the `tty.ReadStream` and `tty.WriteStream`\nclasses.","summary":"The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes. In most cases, it will not be necessary or possible to use this module directly. However, it can be accessed using:","examples":[{"language":"js","displayName":null,"code":"const tty = require('node:tty');"},{"language":"console","displayName":null,"code":"$ node -p -e \"Boolean(process.stdout.isTTY)\"\ntrue\n$ node -p -e \"Boolean(process.stdout.isTTY)\" | cat\nfalse"}],"children":[{"kind":"class","id":"class-ttyreadstream","name":"ReadStream","title":"Class: `tty.ReadStream`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"extends":{"text":"net.Socket","links":[{"name":"net.Socket","href":"net.html#class-netsocket","start":0,"end":10}]},"description":"Represents the readable side of a TTY. In normal circumstances\n[`process.stdin`](process.html#processstdin) will be the only `tty.ReadStream` instance in a Node.js\nprocess and there should be no reason to create additional instances.","summary":"Represents the readable side of a TTY. In normal circumstances `process.stdin` will be the only `tty.ReadStream` instance in a Node.js process and there should be no reason to create additional instances.","examples":[],"children":[{"kind":"property","id":"readstreamisraw","name":"isRaw","title":"`readStream.isRaw`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":null,"default":null,"description":"A `boolean` that is `true` if the TTY is currently configured to operate as a\nraw device.\n\nThis flag is always `false` when a process starts, even if the terminal is\noperating in raw mode. Its value will change with subsequent calls to\n`setRawMode`.","summary":"A `boolean` that is `true` if the TTY is currently configured to operate as a raw device.","examples":[],"children":[]},{"kind":"property","id":"readstreamistty","name":"isTTY","title":"`readStream.isTTY`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":null,"default":null,"description":"A `boolean` that is always `true` for `tty.ReadStream` instances.","summary":"A `boolean` that is always `true` for `tty.ReadStream` instances.","examples":[],"children":[]},{"kind":"method","id":"readstreamsetrawmodemode","name":"setRawMode","title":"`readStream.setRawMode(mode)`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v26.8.0"],"prUrl":"https://github.com/nodejs/node/pull/64140","commit":null,"description":"The `mode` argument supports `'raw'` and `'io'`."}],"signature":{"parameters":[{"name":"mode","type":{"text":"boolean | string","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7},{"name":"string","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type","start":10,"end":16}]},"description":"If `true` or `'raw'`, configures the\n`tty.ReadStream` to operate as a raw device. If `'io'`, configures the\n`tty.ReadStream` to operate in binary-safe I/O mode. If `false`, configures\nthe `tty.ReadStream` to operate in its default mode. The `readStream.isRaw`\nproperty will be set to whether the stream is in raw mode, and the\n`readStream.rawMode` property will be set to the resulting mode.","default":null,"optional":false,"rest":false,"properties":[]}],"returns":{"type":{"text":"this","links":[{"name":"this","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/this","start":0,"end":4}]},"description":"The read stream instance."}},"description":"Allows configuration of `tty.ReadStream` so that it operates as a raw device.\n\nWhen in raw mode, input is always available character-by-character, not\nincluding modifiers. Additionally, all special processing of input characters\nby the terminal is disabled, including echoing input\ncharacters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a `SIGINT` when\nin this mode. This mode does not affect terminal output processing, such as\nnewline translation on Unix terminals.\n\nOn Windows, `setRawMode()` requires write permission to the console input\nbuffer. When opening `\"\\\\\\\\.\\\\CONIN$\"` with the [`fs.open()`](fs.html#fsopenpath-flags-mode-callback) family of APIs\n(for passing into `new tty.ReadStream()`), be sure to use a read/write flag\nsuch as `'r+'`.\n\nWhen in binary-safe I/O mode, terminal output processing is also disabled.\nThis corresponds to libuv's `UV_TTY_MODE_IO` mode and is not supported on\nWindows.","summary":"Allows configuration of `tty.ReadStream` so that it operates as a raw device.","examples":[],"children":[]},{"kind":"property","id":"readstreamrawmode","name":"rawMode","title":"`readStream.rawMode`","scope":"module","overloadOf":null,"stability":null,"added":["v26.8.0"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":{"text":"boolean | string","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7},{"name":"string","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type","start":10,"end":16}]},"default":null,"description":"The current raw mode for the `tty.ReadStream`. This is `false` when the stream\nis in its default mode, `'raw'` when raw input mode is enabled, and `'io'` when\nbinary-safe I/O mode is enabled.","summary":"The current raw mode for the `tty.ReadStream`. This is `false` when the stream is in its default mode, `'raw'` when raw input mode is enabled, and `'io'` when binary-safe I/O mode is enabled.","examples":[],"children":[]}]},{"kind":"class","id":"class-ttywritestream","name":"WriteStream","title":"Class: `tty.WriteStream`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"extends":{"text":"net.Socket","links":[{"name":"net.Socket","href":"net.html#class-netsocket","start":0,"end":10}]},"description":"Represents the writable side of a TTY. In normal circumstances,\n[`process.stdout`](process.html#processstdout) and [`process.stderr`](process.html#processstderr) will be the only\n`tty.WriteStream` instances created for a Node.js process and there\nshould be no reason to create additional instances.","summary":"Represents the writable side of a TTY. In normal circumstances, `process.stdout` and `process.stderr` will be the only `tty.WriteStream` instances created for a Node.js process and there should be no reason to create additional instances.","examples":[],"children":[{"kind":"constructor","id":"new-ttyreadstreamfd-options","name":"ReadStream","title":"`new tty.ReadStream(fd[, options])`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v0.9.4"],"prUrl":null,"commit":null,"description":"The `options` argument is supported."}],"signature":{"parameters":[{"name":"fd","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"A file descriptor associated with a TTY.","default":null,"optional":false,"rest":false,"properties":[]},{"name":"options","type":{"text":"Object","links":[{"name":"Object","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object","start":0,"end":6}]},"description":"Options passed to parent `net.Socket`,\nsee `options` of [`net.Socket` constructor](net.html#new-netsocketoptions).","default":null,"optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"tty.ReadStream","links":[{"name":"tty.ReadStream","href":"tty.html#class-ttyreadstream","start":0,"end":14}]},"description":""}},"description":"Creates a `ReadStream` for `fd` associated with a TTY.","summary":"Creates a `ReadStream` for `fd` associated with a TTY.","examples":[],"children":[]},{"kind":"constructor","id":"new-ttywritestreamfd","name":"WriteStream","title":"`new tty.WriteStream(fd)`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"signature":{"parameters":[{"name":"fd","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"A file descriptor associated with a TTY.","default":null,"optional":false,"rest":false,"properties":[]}],"returns":{"type":{"text":"tty.WriteStream","links":[{"name":"tty.WriteStream","href":"tty.html#class-ttywritestream","start":0,"end":15}]},"description":""}},"description":"Creates a `WriteStream` for `fd` associated with a TTY.","summary":"Creates a `WriteStream` for `fd` associated with a TTY.","examples":[],"children":[]},{"kind":"event","id":"event-resize","name":"resize","title":"Event: `'resize'`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"parameters":[],"description":"The `'resize'` event is emitted whenever either of the `writeStream.columns`\nor `writeStream.rows` properties have changed. No arguments are passed to the\nlistener callback when called.\n\n```js\nprocess.stdout.on('resize', () => {\n  console.log('screen size has changed!');\n  console.log(`${process.stdout.columns}x${process.stdout.rows}`);\n});\n```","summary":"The `'resize'` event is emitted whenever either of the `writeStream.columns` or `writeStream.rows` properties have changed. No arguments are passed to the listener callback when called.","examples":[{"language":"js","displayName":null,"code":"process.stdout.on('resize', () => {\n  console.log('screen size has changed!');\n  console.log(`${process.stdout.columns}x${process.stdout.rows}`);\n});"}],"children":[]},{"kind":"method","id":"writestreamclearlinedir-callback","name":"clearLine","title":"`writeStream.clearLine(dir[, callback])`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v12.7.0"],"prUrl":"https://github.com/nodejs/node/pull/28721","commit":null,"description":"The stream's write() callback and return value are exposed."}],"signature":{"parameters":[{"name":"dir","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"","default":null,"optional":false,"rest":false,"properties":[{"name":"-1","type":null,"description":"to the left from cursor","default":null,"optional":false,"rest":false,"properties":[]},{"name":"1","type":null,"description":"to the right from cursor","default":null,"optional":false,"rest":false,"properties":[]},{"name":"0","type":null,"description":"the entire line","default":null,"optional":false,"rest":false,"properties":[]}]},{"name":"callback","type":{"text":"Function","links":[{"name":"Function","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function","start":0,"end":8}]},"description":"Invoked once the operation completes.","default":null,"optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":"`false` if the stream wishes for the calling code to wait\nfor the `'drain'` event to be emitted before continuing to write additional\ndata; otherwise `true`."}},"description":"`writeStream.clearLine()` clears the current line of this `WriteStream` in a\ndirection identified by `dir`.","summary":"`writeStream.clearLine()` clears the current line of this `WriteStream` in a direction identified by `dir`.","examples":[],"children":[]},{"kind":"method","id":"writestreamclearscreendowncallback","name":"clearScreenDown","title":"`writeStream.clearScreenDown([callback])`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v12.7.0"],"prUrl":"https://github.com/nodejs/node/pull/28721","commit":null,"description":"The stream's write() callback and return value are exposed."}],"signature":{"parameters":[{"name":"callback","type":{"text":"Function","links":[{"name":"Function","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function","start":0,"end":8}]},"description":"Invoked once the operation completes.","default":null,"optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":"`false` if the stream wishes for the calling code to wait\nfor the `'drain'` event to be emitted before continuing to write additional\ndata; otherwise `true`."}},"description":"`writeStream.clearScreenDown()` clears this `WriteStream` from the current\ncursor down.","summary":"`writeStream.clearScreenDown()` clears this `WriteStream` from the current cursor down.","examples":[],"children":[]},{"kind":"property","id":"writestreamcolumns","name":"columns","title":"`writeStream.columns`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":null,"default":null,"description":"A `number` specifying the number of columns the TTY currently has. This property\nis updated whenever the `'resize'` event is emitted.","summary":"A `number` specifying the number of columns the TTY currently has. This property is updated whenever the `'resize'` event is emitted.","examples":[],"children":[]},{"kind":"method","id":"writestreamcursortox-y-callback","name":"cursorTo","title":"`writeStream.cursorTo(x[, y][, callback])`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v12.7.0"],"prUrl":"https://github.com/nodejs/node/pull/28721","commit":null,"description":"The stream's write() callback and return value are exposed."}],"signature":{"parameters":[{"name":"x","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"","default":null,"optional":false,"rest":false,"properties":[]},{"name":"y","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"","default":null,"optional":true,"rest":false,"properties":[]},{"name":"callback","type":{"text":"Function","links":[{"name":"Function","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function","start":0,"end":8}]},"description":"Invoked once the operation completes.","default":null,"optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":"`false` if the stream wishes for the calling code to wait\nfor the `'drain'` event to be emitted before continuing to write additional\ndata; otherwise `true`."}},"description":"`writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified\nposition.","summary":"`writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified position.","examples":[],"children":[]},{"kind":"method","id":"writestreamgetcolordepthenv","name":"getColorDepth","title":"`writeStream.getColorDepth([env])`","scope":"module","overloadOf":null,"stability":null,"added":["v9.9.0"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"signature":{"parameters":[{"name":"env","type":{"text":"Object","links":[{"name":"Object","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object","start":0,"end":6}]},"description":"An object containing the environment variables to check. This\nenables simulating the usage of a specific terminal.","default":"process.env","optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":""}},"description":"Returns:\n\n* `1` for 2,\n* `4` for 16,\n* `8` for 256,\n* `24` for 16,777,216 colors supported.\n\nUse this to determine what colors the terminal supports. Due to the nature of\ncolors in terminals it is possible to either have false positives or false\nnegatives. It depends on process information and the environment variables that\nmay lie about what terminal is used.\nIt is possible to pass in an `env` object to simulate the usage of a specific\nterminal. This can be useful to check how specific environment settings behave.\n\nTo enforce a specific color support, use one of the below environment settings.\n\n* 2 colors: `FORCE_COLOR = 0` (Disables colors)\n* 16 colors: `FORCE_COLOR = 1`\n* 256 colors: `FORCE_COLOR = 2`\n* 16,777,216 colors: `FORCE_COLOR = 3`\n\nDisabling color support is also possible by using the `NO_COLOR` and\n`NODE_DISABLE_COLORS` environment variables.","summary":"Returns:","examples":[],"children":[]},{"kind":"method","id":"writestreamgetwindowsize","name":"getWindowSize","title":"`writeStream.getWindowSize()`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"signature":{"parameters":[],"returns":{"type":{"text":"number[]","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":""}},"description":"`writeStream.getWindowSize()` returns the size of the TTY\ncorresponding to this `WriteStream`. The array is of the type\n`[numColumns, numRows]` where `numColumns` and `numRows` represent the number\nof columns and rows in the corresponding TTY.","summary":"`writeStream.getWindowSize()` returns the size of the TTY corresponding to this `WriteStream`. The array is of the type `[numColumns, numRows]` where `numColumns` and `numRows` represent the number of columns and rows in the corresponding TTY.","examples":[],"children":[]},{"kind":"method","id":"writestreamhascolorscount-env","name":"hasColors","title":"`writeStream.hasColors([count][, env])`","scope":"module","overloadOf":null,"stability":null,"added":["v11.13.0","v10.16.0"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"signature":{"parameters":[{"name":"count","type":{"text":"integer","links":[{"name":"integer","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":7}]},"description":"The number of colors that are requested (minimum 2).","default":"16","optional":true,"rest":false,"properties":[]},{"name":"env","type":{"text":"Object","links":[{"name":"Object","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object","start":0,"end":6}]},"description":"An object containing the environment variables to check. This\nenables simulating the usage of a specific terminal.","default":"process.env","optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":""}},"description":"Returns `true` if the `writeStream` supports at least as many colors as provided\nin `count`. Minimum support is 2 (black and white).\n\nThis has the same false positives and negatives as described in\n[`writeStream.getColorDepth()`](#writestreamgetcolordepthenv).\n\n```js\nprocess.stdout.hasColors();\n// Returns true or false depending on if `stdout` supports at least 16 colors.\nprocess.stdout.hasColors(256);\n// Returns true or false depending on if `stdout` supports at least 256 colors.\nprocess.stdout.hasColors({ TMUX: '1' });\n// Returns true.\nprocess.stdout.hasColors(2 ** 24, { TMUX: '1' });\n// Returns false (the environment setting pretends to support 2 ** 8 colors).\n```","summary":"Returns `true` if the `writeStream` supports at least as many colors as provided in `count`. Minimum support is 2 (black and white).","examples":[{"language":"js","displayName":null,"code":"process.stdout.hasColors();\n// Returns true or false depending on if `stdout` supports at least 16 colors.\nprocess.stdout.hasColors(256);\n// Returns true or false depending on if `stdout` supports at least 256 colors.\nprocess.stdout.hasColors({ TMUX: '1' });\n// Returns true.\nprocess.stdout.hasColors(2 ** 24, { TMUX: '1' });\n// Returns false (the environment setting pretends to support 2 ** 8 colors)."}],"children":[]},{"kind":"property","id":"writestreamistty","name":"isTTY","title":"`writeStream.isTTY`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":null,"default":null,"description":"A `boolean` that is always `true`.","summary":"A `boolean` that is always `true`.","examples":[],"children":[]},{"kind":"method","id":"writestreammovecursordx-dy-callback","name":"moveCursor","title":"`writeStream.moveCursor(dx, dy[, callback])`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[{"versions":["v12.7.0"],"prUrl":"https://github.com/nodejs/node/pull/28721","commit":null,"description":"The stream's write() callback and return value are exposed."}],"signature":{"parameters":[{"name":"dx","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"","default":null,"optional":false,"rest":false,"properties":[]},{"name":"dy","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"","default":null,"optional":false,"rest":false,"properties":[]},{"name":"callback","type":{"text":"Function","links":[{"name":"Function","href":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function","start":0,"end":8}]},"description":"Invoked once the operation completes.","default":null,"optional":true,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":"`false` if the stream wishes for the calling code to wait\nfor the `'drain'` event to be emitted before continuing to write additional\ndata; otherwise `true`."}},"description":"`writeStream.moveCursor()` moves this `WriteStream`'s cursor *relative* to its\ncurrent position.","summary":"`writeStream.moveCursor()` moves this `WriteStream`'s cursor _relative_ to its current position.","examples":[],"children":[]},{"kind":"property","id":"writestreamrows","name":"rows","title":"`writeStream.rows`","scope":"module","overloadOf":null,"stability":null,"added":["v0.7.7"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"type":null,"default":null,"description":"A `number` specifying the number of rows the TTY currently has. This property\nis updated whenever the `'resize'` event is emitted.","summary":"A `number` specifying the number of rows the TTY currently has. This property is updated whenever the `'resize'` event is emitted.","examples":[],"children":[]}]},{"kind":"method","id":"ttyisattyfd","name":"isatty","title":"`tty.isatty(fd)`","scope":"module","overloadOf":null,"stability":null,"added":["v0.5.8"],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"signature":{"parameters":[{"name":"fd","type":{"text":"number","links":[{"name":"number","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type","start":0,"end":6}]},"description":"A numeric file descriptor","default":null,"optional":false,"rest":false,"properties":[]}],"returns":{"type":{"text":"boolean","links":[{"name":"boolean","href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type","start":0,"end":7}]},"description":""}},"description":"The `tty.isatty()` method returns `true` if the given `fd` is associated with\na TTY and `false` if it is not, including whenever `fd` is not a non-negative\ninteger.","summary":"The `tty.isatty()` method returns `true` if the given `fd` is associated with a TTY and `false` if it is not, including whenever `fd` is not a non-negative integer.","examples":[],"children":[]}]}