{ "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:
const tty = require('tty');\n
\nWhen Node.js detects that it is being run inside a text terminal ("TTY")\ncontext, the 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
:
$ node -p -e "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p -e "Boolean(process.stdout.isTTY)" | cat\nfalse\n
\nIn most cases, there should be little to no reason for an application to\ncreate instances of the tty.ReadStream
and tty.WriteStream
classes.
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.
A boolean
that is true
if the TTY is currently configured to operate as a\nraw device. Defaults to false
.
Allows configuration of tty.ReadStream
so that it operates as a raw device.
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.
mode
{boolean} If true
, configures the tty.ReadStream
to operate as a\nraw device. If false
, configures the tty.ReadStream
to operate in its\ndefault mode. The readStream.isRaw
property will be set to the resulting\nmode.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.
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.
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"
]
},
"desc": "A number
specifying the number of columns the TTY currently has. This property\nis updated whenever the 'resize'
event is emitted.
A number
specifying the number of rows the TTY currently has. This property\nis updated whenever the 'resize'
event is emitted.
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.