doc: readline document TTY utils

fix #6933
pull/5010/head
Fedor Indutny 2014-01-23 15:35:50 +04:00 committed by Timothy J Fontaine
parent 9975ff603b
commit 0ec3770767
1 changed files with 20 additions and 0 deletions

View File

@ -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.