diff options
| author | Fedor Indutny <fedor.indutny@gmail.com> | 2014-01-23 15:35:50 +0400 |
|---|---|---|
| committer | Timothy J Fontaine <tjfontaine@gmail.com> | 2014-01-25 12:10:44 -0800 |
| commit | 0ec3770767dd24254d137ac45fe34897ec0443b8 (patch) | |
| tree | ea3d3a8711c4c9f8662ae9bf3ea3541163faeed8 /doc | |
| parent | 9975ff603b5ba0e5f4b2f0ffb07474a9013dab36 (diff) | |
| download | android-node-v8-0ec3770767dd24254d137ac45fe34897ec0443b8.tar.gz android-node-v8-0ec3770767dd24254d137ac45fe34897ec0443b8.tar.bz2 android-node-v8-0ec3770767dd24254d137ac45fe34897ec0443b8.zip | |
doc: readline document TTY utils
fix #6933
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/readline.markdown | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/readline.markdown b/doc/api/readline.markdown index bcfbe4f590..1fa08a1905 100644 --- a/doc/api/readline.markdown +++ b/doc/api/readline.markdown @@ -281,3 +281,23 @@ line interface: process.exit(0); }); +## readline.cursorTo(stream, x, y) + +Move cursor to the specified position in a given TTY stream. + +## readline.moveCursor(stream, dx, dy) + +Move cursor relative to it's current position in a given TTY stream. + +## readline.clearLine(stream, dir) + +Clears current line of given TTY stream in a specified direction. +`dir` should have one of following values: + +* `-1` - to the left from cursor +* `1` - to the right from cursor +* `0` - the entire line + +## readline.clearScreenDown(stream) + +Clears the screen from the current position of the cursor down. |