Skip to content

Commit 3cdf94d

Browse files
jakecastelliAyase-252
authored andcommitted
doc,tty: add documentation for ReadStream and WriteStream
Co-authored-by: Qingyu Deng <i@ayase-lab.com> PR-URL: #53567 Fixes: #37780 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Raz Luvaton <rluvaton@gmail.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org>
1 parent 233aba9 commit 3cdf94d

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

doc/api/tty.md

+28
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,33 @@ Represents the writable side of a TTY. In normal circumstances,
9898
`tty.WriteStream` instances created for a Node.js process and there
9999
should be no reason to create additional instances.
100100

101+
### `new tty.ReadStream(fd[, options])`
102+
103+
<!-- YAML
104+
added: v0.5.8
105+
changes:
106+
- version: v0.9.4
107+
description: The `options` argument is supported.
108+
-->
109+
110+
* `fd` {number} A file descriptor associated with a TTY.
111+
* `options` {Object} Options passed to parent `net.Socket`,
112+
see `options` of [`net.Socket` constructor][].
113+
* Returns {tty.ReadStream}
114+
115+
Creates a `ReadStream` for `fd` associated with a TTY.
116+
117+
### `new tty.WriteStream(fd)`
118+
119+
<!-- YAML
120+
added: v0.5.8
121+
-->
122+
123+
* `fd` {number} A file descriptor associated with a TTY.
124+
* Returns {tty.WriteStream}
125+
126+
Creates a `WriteStream` for `fd` associated with a TTY.
127+
101128
### Event: `'resize'`
102129

103130
<!-- YAML
@@ -314,6 +341,7 @@ The `tty.isatty()` method returns `true` if the given `fd` is associated with
314341
a TTY and `false` if it is not, including whenever `fd` is not a non-negative
315342
integer.
316343

344+
[`net.Socket` constructor]: net.md#new-netsocketoptions
317345
[`process.stderr`]: process.md#processstderr
318346
[`process.stdin`]: process.md#processstdin
319347
[`process.stdout`]: process.md#processstdout

tools/doc/type-parser.mjs

+3
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,9 @@ const customTypesMap = {
219219

220220
'Tracing': 'tracing.html#tracing-object',
221221

222+
'tty.ReadStream': 'tty.html#class-ttyreadstream',
223+
'tty.WriteStream': 'tty.html#class-ttywritestream',
224+
222225
'URL': 'url.html#the-whatwg-url-api',
223226
'URLSearchParams': 'url.html#class-urlsearchparams',
224227

0 commit comments

Comments
 (0)