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])` + + + +* `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)` + + + +* `fd` {number} A file descriptor associated with a TTY. +* Returns {tty.WriteStream} + +Creates a `WriteStream` for `fd` associated with a TTY. + ### Event: `'resize'`