{ "source": "doc/api/tty.md", "modules": [ { "textRaw": "TTY", "name": "tty", "introduced_in": "v0.10.0", "stability": 2, "stabilityText": "Stable", "desc": "

The tty module provides the tty.ReadStream and tty.WriteStream classes.\nIn most cases, it will not be necessary or possible to use this module directly.\nHowever, it can be accessed using:

\n
const tty = require('tty');\n
\n

When Node.js detects that it is being run with a text terminal ("TTY")\nattached, process.stdin will, by default, be initialized as an instance of\ntty.ReadStream and both process.stdout and process.stderr 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
$ node -p -e "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p -e "Boolean(process.stdout.isTTY)" | cat\nfalse\n
\n

In most cases, there should be little to no reason for an application to\nmanually create instances of the tty.ReadStream and tty.WriteStream\nclasses.

\n", "classes": [ { "textRaw": "Class: tty.ReadStream", "type": "class", "name": "tty.ReadStream", "meta": { "added": [ "v0.5.8" ], "changes": [] }, "desc": "

The tty.ReadStream class is a subclass of net.Socket that represents the\nreadable side of a TTY. In normal circumstances process.stdin will be the\nonly tty.ReadStream instance in a Node.js process and there should be no\nreason to create additional instances.

\n", "properties": [ { "textRaw": "readStream.isRaw", "name": "isRaw", "meta": { "added": [ "v0.7.7" ], "changes": [] }, "desc": "

A boolean that is true if the TTY is currently configured to operate as a\nraw device. Defaults to false.

\n" }, { "textRaw": "readStream.isTTY", "name": "isTTY", "meta": { "added": [ "v0.5.8" ], "changes": [] }, "desc": "

A boolean that is always true for tty.ReadStream instances.

\n" } ], "methods": [ { "textRaw": "readStream.setRawMode(mode)", "type": "method", "name": "setRawMode", "meta": { "added": [ "v0.7.7" ], "changes": [] }, "desc": "

Allows configuration of tty.ReadStream so that it operates as a raw device.

\n

When in raw mode, input is always available character-by-character, not\nincluding modifiers. Additionally, all special processing of characters by the\nterminal is disabled, including echoing input characters.\nNote that CTRL+C will no longer cause a SIGINT when in this mode.

\n\n", "signatures": [ { "params": [ { "name": "mode" } ] } ] } ] }, { "textRaw": "Class: tty.WriteStream", "type": "class", "name": "tty.WriteStream", "meta": { "added": [ "v0.5.8" ], "changes": [] }, "desc": "

The tty.WriteStream class is a subclass of net.Socket that represents the\nwritable side of a TTY. In normal circumstances, process.stdout and\nprocess.stderr will be the only tty.WriteStream instances created for a\nNode.js process and there should be no reason to create additional instances.

\n", "events": [ { "textRaw": "Event: 'resize'", "type": "event", "name": "resize", "meta": { "added": [ "v0.7.7" ], "changes": [] }, "desc": "

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
process.stdout.on('resize', () => {\n  console.log('screen size has changed!');\n  console.log(`${process.stdout.columns}x${process.stdout.rows}`);\n});\n
\n", "params": [] } ], "properties": [ { "textRaw": "writeStream.columns", "name": "columns", "meta": { "added": [ "v0.7.7" ], "changes": [] }, "desc": "

A number specifying the number of columns the TTY currently has. This property\nis updated whenever the 'resize' event is emitted.

\n" }, { "textRaw": "writeStream.isTTY", "name": "isTTY", "meta": { "added": [ "v0.5.8" ], "changes": [] }, "desc": "

A boolean that is always true.

\n" }, { "textRaw": "writeStream.rows", "name": "rows", "meta": { "added": [ "v0.7.7" ], "changes": [] }, "desc": "

A number specifying the number of rows the TTY currently has. This property\nis updated whenever the 'resize' event is emitted.

\n" } ], "methods": [ { "textRaw": "writeStream.getColorDepth([env])", "type": "method", "name": "getColorDepth", "meta": { "added": [ "v9.9.0" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {number} ", "name": "return", "type": "number" }, "params": [ { "textRaw": "`env` {object} A object containing the environment variables to check. Defaults to `process.env`. ", "name": "env", "type": "object", "desc": "A object containing the environment variables to check. Defaults to `process.env`.", "optional": true } ] }, { "params": [ { "name": "env", "optional": true } ] } ], "desc": "

Returns:

\n\n

Use 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.\nTo enforce a specific behavior without relying on process.env it is possible\nto pass in an object with different settings.

\n

Use the NODE_DISABLE_COLORS environment variable to enforce this function to\nalways return 1.

\n" } ] } ], "methods": [ { "textRaw": "tty.isatty(fd)", "type": "method", "name": "isatty", "meta": { "added": [ "v0.5.8" ], "changes": [] }, "signatures": [ { "params": [ { "textRaw": "`fd` {number} A numeric file descriptor ", "name": "fd", "type": "number", "desc": "A numeric file descriptor" } ] }, { "params": [ { "name": "fd" } ] } ], "desc": "

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.

\n" } ], "type": "module", "displayName": "TTY" } ] }