GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc,tty: add documentation for ReadStream and WriteStream · nodejs/node@3cdf94d

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- tty.md
tools/doc
- type-parser.mjs

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/tty.md‎`

Copy file name to clipboardExpand all lines: doc/api/tty.md

+28Lines changed: 28 additions & 0 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,33 @@ Represents the writable side of a TTY. In normal circumstances,`
`98`	`98`	`tty.WriteStream` instances created for a Node.js process and there
`99`	`99`	`should be no reason to create additional instances.`
`100`	`100`
	`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`	`+`
`101`	`128`	### Event: `'resize'`
`102`	`129`
`103`	`130`	`<!-- YAML`
@@ -314,6 +341,7 @@ The `tty.isatty()` method returns `true` if the given `fd` is associated with
`314`	`341`	a TTY and `false` if it is not, including whenever `fd` is not a non-negative
`315`	`342`	`integer.`
`316`	`343`
	`344`	+[`net.Socket` constructor]: net.md#new-netsocketoptions
`317`	`345`	[`process.stderr`]: process.md#processstderr
`318`	`346`	[`process.stdin`]: process.md#processstdin
`319`	`347`	[`process.stdout`]: process.md#processstdout

Collapse file

`‎tools/doc/type-parser.mjs‎`

Copy file name to clipboardExpand all lines: tools/doc/type-parser.mjs

+3Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -219,6 +219,9 @@ const customTypesMap = {`
`219`	`219`
`220`	`220`	`'Tracing': 'tracing.html#tracing-object',`
`221`	`221`
	`222`	`+ 'tty.ReadStream': 'tty.html#class-ttyreadstream',`
	`223`	`+ 'tty.WriteStream': 'tty.html#class-ttywritestream',`
	`224`	`+`
`222`	`225`	`'URL': 'url.html#the-whatwg-url-api',`
`223`	`226`	`'URLSearchParams': 'url.html#class-urlsearchparams',`
`224`	`227`

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.