summaryrefslogtreecommitdiff
path: root/doc/api/tty.md
diff options
context:
space:
mode:
authorJeremiah Senkpiel <fishrock123@rocketmail.com>2017-12-15 16:50:32 -0500
committerJeremiah Senkpiel <fishrock123@rocketmail.com>2017-12-18 10:26:09 -0500
commit606ff7c6f2cb8ab36bdbbe782eaef66f83a42f08 (patch)
tree9b5b5b41cf6481d4e65ccf2d2760cd120105fb3e /doc/api/tty.md
parent934490b3f6e7368b5786f43964cf8001208f4e04 (diff)
downloadandroid-node-v8-606ff7c6f2cb8ab36bdbbe782eaef66f83a42f08.tar.gz
android-node-v8-606ff7c6f2cb8ab36bdbbe782eaef66f83a42f08.tar.bz2
android-node-v8-606ff7c6f2cb8ab36bdbbe782eaef66f83a42f08.zip
doc: adjust TTY wording & add inter-doc links
PR-URL: https://github.com/nodejs/node/pull/17702 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/tty.md')
-rw-r--r--doc/api/tty.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md
index f91a37a120..8b757c0f02 100644
--- a/doc/api/tty.md
+++ b/doc/api/tty.md
@@ -12,9 +12,9 @@ However, it can be accessed using:
const tty = require('tty');
```
-When Node.js detects that it is being run inside a text terminal ("TTY")
-context, the `process.stdin` will, by default, be initialized as an instance of
-`tty.ReadStream` and both `process.stdout` and `process.stderr` will, by
+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`:
@@ -27,15 +27,16 @@ false
```
In most cases, there should be little to no reason for an application to
-create instances of the `tty.ReadStream` and `tty.WriteStream` classes.
+manually create instances of the `tty.ReadStream` and `tty.WriteStream`
+classes.
## Class: tty.ReadStream
<!-- YAML
added: v0.5.8
-->
-The `tty.ReadStream` class is a subclass of `net.Socket` that represents the
-readable side of a TTY. In normal circumstances `process.stdin` will be the
+The `tty.ReadStream` class is a subclass of [`net.Socket`][] that 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.
@@ -52,7 +53,7 @@ raw device. Defaults to `false`.
added: v0.5.8
-->
-A `boolean` that is always `true`.
+A `boolean` that is always `true` for `tty.ReadStream` instances.
### readStream.setRawMode(mode)
<!-- YAML
@@ -77,8 +78,8 @@ added: v0.5.8
-->
The `tty.WriteStream` class is a subclass of `net.Socket` that 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
+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.
### Event: 'resize'
@@ -130,3 +131,8 @@ added: 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.
+
+[`net.Socket`]: net.html#net_class_net_socket
+[`process.stdin`]: process.html#process_process_stdin
+[`process.stdout`]: process.html#process_process_stdout
+[`process.stderr`]: process.html#process_process_stderr