diff options
| author | cjihrig <cjihrig@gmail.com> | 2016-04-02 20:55:17 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2016-04-05 10:48:47 -0400 |
| commit | 3de9bc94294d0cab691d8a6e261733e8a8e98342 (patch) | |
| tree | bcc25d366e996145a0c3744f6af46b6a163572ea /doc | |
| parent | b85a50b6da5bbd7e9c8902a13dfbe1a142fd786a (diff) | |
| download | android-node-v8-3de9bc94294d0cab691d8a6e261733e8a8e98342.tar.gz android-node-v8-3de9bc94294d0cab691d8a6e261733e8a8e98342.tar.bz2 android-node-v8-3de9bc94294d0cab691d8a6e261733e8a8e98342.zip | |
readline: document emitKeypressEvents()
This commit adds documentation to the already publicly available
readline.emitKeypressEvents() method.
PR-URL: https://github.com/nodejs/node/pull/6024
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/readline.markdown | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/readline.markdown b/doc/api/readline.markdown index c2b77c5245..db543d2306 100644 --- a/doc/api/readline.markdown +++ b/doc/api/readline.markdown @@ -354,6 +354,11 @@ a `'resize'` event on the `output` if/when the columns ever change Move cursor to the specified position in a given TTY stream. +## readline.emitKeypressEvents(stream) + +Causes `stream` to begin emitting `'keypress'` events corresponding to its +input. + ## readline.moveCursor(stream, dx, dy) Move cursor relative to it's current position in a given TTY stream. |