TTY
目录
- Class: tty.ReadStream
- Class: tty.WriteStream
- Event: 'resize'
- writeStream.clearLine(dir[, callback])
- writeStream.clearScreenDown([callback])
- writeStream.columns
- writeStream.cursorTo(x[, y][, callback])
- writeStream.getColorDepth([env])
- writeStream.getWindowSize()
- writeStream.hasColors([count][, env])
- writeStream.isTTY
- writeStream.moveCursor(dx, dy[, callback])
- writeStream.rows
- tty.isatty(fd)
Added in: v0.10.0
源代码: lib/tty.js
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:
JS
When Node.js detects that it is being run with a text terminal ("TTY")
attached, process.stdin
will, by default, be initialized as an instance of
tty.ReadStream
and both process.stdout
and process.stderr
will, by
default, be instances of tty.WriteStream
. The preferred method of determining
whether Node.js is being run within a TTY context is to check that the value of
the process.stdout.isTTY
property is true
:
BASH
In most cases, there should be little to no reason for an application to
manually create instances of the tty.ReadStream
and tty.WriteStream
classes.
C tty.ReadStream
Added in: v0.5.8
- Extends:
net.Socket
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.
M readStream.isRaw
Added in: v0.7.7
A boolean
that is true
if the TTY is currently configured to operate as a
raw device. Defaults to false
.
M readStream.isTTY
Added in: v0.5.8
A boolean
that is always true
for tty.ReadStream
instances.
M readStream.setRawMode(mode)
Added in: v0.7.7
mode
boolean
Iftrue
, configures thetty.ReadStream
to operate as a raw device. Iffalse
, configures thetty.ReadStream
to operate in its default mode. ThereadStream.isRaw
property will be set to the resulting mode.- Returns:
this
The read stream instance.
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
including modifiers. Additionally, all special processing of characters by the
terminal is disabled, including echoing input
characters. Ctrl+C will no longer cause a SIGINT
when
in this mode.
C tty.WriteStream
Added in: v0.5.8
- Extends:
net.Socket
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.
E 'resize'
Added in: v0.7.7
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.
JS
M writeStream.clearLine(dir[, callback])
历史
版本 | 更改 |
---|---|
v12.7.0 | The stream's write() callback and return value are exposed. |
v0.7.7 | Added in: v0.7.7 |
dir
number
-1
: to the left from cursor1
: to the right from cursor0
: the entire line
callback
Function
Invoked once the operation completes.- Returns:
boolean
false
if the stream wishes for the calling code to wait for the'drain'
event to be emitted before continuing to write additional data; otherwisetrue
.
writeStream.clearLine()
clears the current line of this WriteStream
in a
direction identified by dir
.
M writeStream.clearScreenDown([callback])
历史
版本 | 更改 |
---|---|
v12.7.0 | The stream's write() callback and return value are exposed. |
v0.7.7 | Added in: v0.7.7 |
callback
Function
Invoked once the operation completes.- Returns:
boolean
false
if the stream wishes for the calling code to wait for the'drain'
event to be emitted before continuing to write additional data; otherwisetrue
.
writeStream.clearScreenDown()
clears this WriteStream
from the current
cursor down.
M writeStream.columns
Added in: v0.7.7
A number
specifying the number of columns the TTY currently has. This property
is updated whenever the 'resize'
event is emitted.
M writeStream.cursorTo(x[, y][, callback])
历史
版本 | 更改 |
---|---|
v12.7.0 | The stream's write() callback and return value are exposed. |
v0.7.7 | Added in: v0.7.7 |
x
number
y
number
callback
Function
Invoked once the operation completes.- Returns:
boolean
false
if the stream wishes for the calling code to wait for the'drain'
event to be emitted before continuing to write additional data; otherwisetrue
.
writeStream.cursorTo()
moves this WriteStream
's cursor to the specified
position.
M writeStream.getColorDepth([env])
Added in: v9.9.0
env
Object
An object containing the environment variables to check. This enables simulating the usage of a specific terminal. Default:process.env
.- Returns:
number
Returns:
1
for 2,4
for 16,8
for 256,24
for 16,777,216 colors supported.
Use this to determine what colors the terminal supports. Due to the nature of
colors in terminals it is possible to either have false positives or false
negatives. It depends on process information and the environment variables that
may lie about what terminal is used.
It is possible to pass in an env
object to simulate the usage of a specific
terminal. This can be useful to check how specific environment settings behave.
To enforce a specific color support, use one of the below environment settings.
- 2 colors:
FORCE_COLOR = 0
(Disables colors) - 16 colors:
FORCE_COLOR = 1
- 256 colors:
FORCE_COLOR = 2
- 16,777,216 colors:
FORCE_COLOR = 3
Disabling color support is also possible by using the NO_COLOR
and
NODE_DISABLE_COLORS
environment variables.
M writeStream.getWindowSize()
Added in: v0.7.7
- Returns: number[]
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.
M writeStream.hasColors([count][, env])
Added in: v11.13.0, v10.16.0
count
integer
The number of colors that are requested (minimum 2). Default: 16.env
Object
An object containing the environment variables to check. This enables simulating the usage of a specific terminal. Default:process.env
.- Returns:
boolean
Returns true
if the writeStream
supports at least as many colors as provided
in count
. Minimum support is 2 (black and white).
This has the same false positives and negatives as described in
writeStream.getColorDepth()
.
JS
M writeStream.isTTY
Added in: v0.5.8
A boolean
that is always true
.
M writeStream.moveCursor(dx, dy[, callback])
历史
版本 | 更改 |
---|---|
v12.7.0 | The stream's write() callback and return value are exposed. |
v0.7.7 | Added in: v0.7.7 |
dx
number
dy
number
callback
Function
Invoked once the operation completes.- Returns:
boolean
false
if the stream wishes for the calling code to wait for the'drain'
event to be emitted before continuing to write additional data; otherwisetrue
.
writeStream.moveCursor()
moves this WriteStream
's cursor relative to its
current position.
M writeStream.rows
Added in: v0.7.7
A number
specifying the number of rows the TTY currently has. This property
is updated whenever the 'resize'
event is emitted.
M tty.isatty(fd)
Added in: v0.5.8
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.