tty: document WriteStream.cursorTo() and others

Adds documentation for the following `WriteStream` instance methods: - `WriteStream.clearLine()` - `WriteStream.clearScreenDown()` - `WriteStream.cursorTo()` - `WriteStream.getWindowSize()` - `WriteStream.moveCursor()` PR-URL: #22893 Fixes: #9853 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
nodejs · Oct 7, 2018 · bf17708 · bf17708
1 parent bd59d4e
commit bf17708
Showing 1 changed file with 62 additions and 8 deletions.
diff --git a/doc/api/tty.md b/doc/api/tty.md
@@ -99,29 +99,46 @@ process.stdout.on('resize', () => {
 });
 ```
 
-### writeStream.columns
+### writeStream.clearLine(dir)
 <!-- YAML
 added: v0.7.7
 -->
 
-A `number` specifying the number of columns the TTY currently has. This property
-is updated whenever the `'resize'` event is emitted.
+* `dir` {number}
+  * `-1` - to the left from cursor
+  * `1` - to the right from cursor
+  * `0` - the entire line
 
-### writeStream.isTTY
+`writeStream.clearLine()` clears the current line of this `WriteStream` in a
+direction identified by `dir`.
+
+### writeStream.clearScreenDown()
 <!-- YAML
-added: v0.5.8
+added: v0.7.7
 -->
 
-A `boolean` that is always `true`.
+`writeStream.clearScreenDown()` clears this `WriteStream` from the current
+cursor down.
 
-### writeStream.rows
+### writeStream.columns
 <!-- YAML
 added: v0.7.7
 -->
 
-A `number` specifying the number of rows the TTY currently has. This property
+A `number` specifying the number of columns the TTY currently has. This property
 is updated whenever the `'resize'` event is emitted.
 
+### writeStream.cursorTo(x, y)
+<!-- YAML
+added: v0.7.7
+-->
+
+* `x` {number}
+* `y` {number}
+
+`writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified
+position.
+
 ### writeStream.getColorDepth([env])
 <!-- YAML
 added: v9.9.0
@@ -148,6 +165,43 @@ to pass in an object with different settings.
 Use the `NODE_DISABLE_COLORS` environment variable to enforce this function to
 always return 1.
 
+### writeStream.getWindowSize()
+<!-- YAML
+added: v0.7.7
+-->
+* Returns: {number[]}
+
+`writeStream.getWindowSize()` returns the size of the [TTY](tty.html)
+corresponding to this `WriteStream`. The array is of the type
+`[numColumns, numRows]` where `numColumns` and `numRows` represent the number
+of columns and rows in the corresponding [TTY](tty.html).
+
+### writeStream.isTTY
+<!-- YAML
+added: v0.5.8
+-->
+
+A `boolean` that is always `true`.
+
+### writeStream.moveCursor(dx, dy)
+<!-- YAML
+added: v0.7.7
+-->
+
+* `dx` {number}
+* `dy` {number}
+
+`writeStream.moveCursor()` moves this `WriteStream`'s cursor *relative* to its
+current position.
+
+### writeStream.rows
+<!-- YAML
+added: v0.7.7
+-->
+
+A `number` specifying the number of rows the TTY currently has. This property
+is updated whenever the `'resize'` event is emitted.
+
 ## tty.isatty(fd)
 <!-- YAML
 added: v0.5.8