summaryrefslogtreecommitdiff
path: root/doc/api/tty.md
diff options
context:
space:
mode:
authorUmang Raghuvanshi <u@umangis.me>2018-09-17 14:14:42 +0530
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-10-06 01:36:03 +0300
commit2ba19ff2b8a6253c6fb7795f35d4fb1c30ec6c30 (patch)
treedd064ccfc80e58f6568efc586a8161a8bba82910 /doc/api/tty.md
parent054481633a3a6feba53213b8a5335ccfa421de0e (diff)
downloadandroid-node-v8-2ba19ff2b8a6253c6fb7795f35d4fb1c30ec6c30.tar.gz
android-node-v8-2ba19ff2b8a6253c6fb7795f35d4fb1c30ec6c30.tar.bz2
android-node-v8-2ba19ff2b8a6253c6fb7795f35d4fb1c30ec6c30.zip
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: https://github.com/nodejs/node/pull/22893 Fixes: https://github.com/nodejs/node/issues/9853 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/tty.md')
-rw-r--r--doc/api/tty.md70
1 files changed, 62 insertions, 8 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md
index 45b66abb9e..2b20548156 100644
--- 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