Skip to content

Commit

Permalink
doc,tty: add documentation for ReadStream and WriteStream
Browse files Browse the repository at this point in the history
Co-authored-by: Qingyu Deng <[email protected]>
PR-URL: #53567
Fixes: #37780
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Raz Luvaton <[email protected]>
Reviewed-By: Claudio Wunder <[email protected]>
  • Loading branch information
2 people authored and marco-ippolito committed Aug 19, 2024
1 parent 233aba9 commit 3cdf94d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
28 changes: 28 additions & 0 deletions doc/api/tty.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions tools/doc/type-parser.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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',

Expand Down

0 comments on commit 3cdf94d

Please sign in to comment.