diff options
| author | Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> | 2019-08-24 08:02:23 +0300 |
|---|---|---|
| committer | Trivikram Kamat <16024985+trivikr@users.noreply.github.com> | 2019-09-01 18:18:10 +0300 |
| commit | 89aea1514b3b44d4b60c6c556aa70e9ffed46391 (patch) | |
| tree | 53ac24a4a4dae3b14e04a94043bbfe03dab85317 /doc/api/tty.md | |
| parent | 9ab1e07774b0c38a66e29f4b0b257ded8ee04d08 (diff) | |
doc: add extends for derived classes
PR-URL: https://github.com/nodejs/node/pull/29290
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/tty.md')
| -rw-r--r-- | doc/api/tty.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md index 335aef7589b..7111f2d228b 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -35,10 +35,11 @@ classes. 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 -only `tty.ReadStream` instance in a Node.js process and there should be no -reason to create additional instances. +* 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. ### readStream.isRaw <!-- YAML @@ -78,10 +79,12 @@ terminal is disabled, including echoing input characters. 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 -Node.js process and there should be no reason to create additional instances. +* 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. ### Event: 'resize' <!-- YAML @@ -284,7 +287,6 @@ 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.stderr`]: process.html#process_process_stderr [`process.stdin`]: process.html#process_process_stdin [`process.stdout`]: process.html#process_process_stdout |