From f6897debc6718e3b51dd3e49b976a2e3acd72f20 Mon Sep 17 00:00:00 2001
From: jakecastelli <959672929@qq.com>
Date: Mon, 24 Jun 2024 14:56:48 +0930
Subject: [PATCH 1/2] doc,tty: add documentation for ReadStream and WriteStream

Co-authored-by: Qingyu Deng <i@ayase-lab.com>
---
 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..07d0180a8cc3a3 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#net_new_socket_options
 [`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 4e962e1c1ec864..f0959f9912b829 100644
--- a/tools/doc/type-parser.mjs
+++ b/tools/doc/type-parser.mjs
@@ -221,6 +221,9 @@ const customTypesMap = {
 
   'Tracing': 'tracing.html#tracing-object',
 
+  'tty.ReadStream': 'tty.html#tty_class_tty_readstream',
+  'tty.WriteStream': 'tty.html#tty_class_tty_writestream',
+
   'URL': 'url.html#the-whatwg-url-api',
   'URLSearchParams': 'url.html#class-urlsearchparams',
 

From e63bbd3dad06813ac0205922671873c08c2a9411 Mon Sep 17 00:00:00 2001
From: jakecastelli <959672929@qq.com>
Date: Mon, 24 Jun 2024 23:55:53 +0930
Subject: [PATCH 2/2] fixup!

---
 doc/api/tty.md            | 2 +-
 tools/doc/type-parser.mjs | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/api/tty.md b/doc/api/tty.md
index 07d0180a8cc3a3..1139355ed0f280 100644
--- a/doc/api/tty.md
+++ b/doc/api/tty.md
@@ -341,7 +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#net_new_socket_options
+[`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 f0959f9912b829..fdf70bd935623d 100644
--- a/tools/doc/type-parser.mjs
+++ b/tools/doc/type-parser.mjs
@@ -221,8 +221,8 @@ const customTypesMap = {
 
   'Tracing': 'tracing.html#tracing-object',
 
-  'tty.ReadStream': 'tty.html#tty_class_tty_readstream',
-  'tty.WriteStream': 'tty.html#tty_class_tty_writestream',
+  'tty.ReadStream': 'tty.html#class-ttyreadstream',
+  'tty.WriteStream': 'tty.html#class-ttywritestream',
 
   'URL': 'url.html#the-whatwg-url-api',
   'URLSearchParams': 'url.html#class-urlsearchparams',