From 3cdf94d403460f1f1474c15e808f78408bb0c272 Mon Sep 17 00:00:00 2001
From: jakecastelli <38635403+jakecastelli@users.noreply.github.com>
Date: Fri, 19 Jul 2024 17:53:24 +0700
Subject: [PATCH] doc,tty: add documentation for ReadStream and WriteStream

Co-authored-by: Qingyu Deng <i@ayase-lab.com>
PR-URL: https://github.com/nodejs/node/pull/53567
Fixes: https://github.com/nodejs/node/issues/37780
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Raz Luvaton <rluvaton@gmail.com>
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
---
 doc/api/tty.md            | 28 ++++++++++++++++++++++++++++
 tools/doc/type-parser.mjs |  3 +++
 2 files changed, 31 insertions(+)

diff --git a/doc/api/tty.md b/doc/api/tty.md
index 1234526dd588dd..1139355ed0f280 100644
--- a/doc/api/tty.md
+++ b/doc/api/tty.md
@@ -98,6 +98,33 @@ Represents the writable side of a TTY. In normal circumstances,
 `tty.WriteStream` instances created for a Node.js process and there
 should be no reason to create additional instances.
 
+### `new tty.ReadStream(fd[, options])`
+
+<!-- YAML
+added: v0.5.8
+changes:
+  - version: v0.9.4
+    description: The `options` argument is supported.
+-->
+
+* `fd` {number} A file descriptor associated with a TTY.
+* `options` {Object} Options passed to parent `net.Socket`,
+  see `options` of [`net.Socket` constructor][].
+* Returns {tty.ReadStream}
+
+Creates a `ReadStream` for `fd` associated with a TTY.
+
+### `new tty.WriteStream(fd)`
+
+<!-- YAML
+added: v0.5.8
+-->
+
+* `fd` {number} A file descriptor associated with a TTY.
+* Returns {tty.WriteStream}
+
+Creates a `WriteStream` for `fd` associated with a TTY.
+
 ### Event: `'resize'`
 
 <!-- YAML
@@ -314,6 +341,7 @@ 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` constructor]: net.md#new-netsocketoptions
 [`process.stderr`]: process.md#processstderr
 [`process.stdin`]: process.md#processstdin
 [`process.stdout`]: process.md#processstdout
diff --git a/tools/doc/type-parser.mjs b/tools/doc/type-parser.mjs
index a3da66babfbb84..9ee9873734cb4b 100644
--- a/tools/doc/type-parser.mjs
+++ b/tools/doc/type-parser.mjs
@@ -219,6 +219,9 @@ const customTypesMap = {
 
   'Tracing': 'tracing.html#tracing-object',
 
+  'tty.ReadStream': 'tty.html#class-ttyreadstream',
+  'tty.WriteStream': 'tty.html#class-ttywritestream',
+
   'URL': 'url.html#the-whatwg-url-api',
   'URLSearchParams': 'url.html#class-urlsearchparams',