Skip to content
Permalink
Browse files

readline: document emitKeypressEvents()

This commit adds documentation to the already publicly available
readline.emitKeypressEvents() method.

PR-URL: #6024
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
  • Loading branch information...
cjihrig committed Apr 3, 2016
1 parent b85a50b commit 3de9bc94294d0cab691d8a6e261733e8a8e98342
Showing with 35 additions and 0 deletions.
  1. +5 −0 doc/api/readline.markdown
  2. +30 −0 test/parallel/test-readline-emit-keypress-events.js
@@ -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.
@@ -0,0 +1,30 @@
'use strict';
// emitKeypressEvents is thoroughly tested in test-readline-keys.js.
// However, that test calls it implicitly. This is just a quick sanity check
// to verify that it works when called explicitly.

require('../common');
const assert = require('assert');
const readline = require('readline');
const PassThrough = require('stream').PassThrough;
const stream = new PassThrough();
const sequence = [];
const keys = [];

readline.emitKeypressEvents(stream);

stream.on('keypress', (s, k) => {
sequence.push(s);
keys.push(k);
});

stream.write('foo');

process.on('exit', () => {
assert.deepStrictEqual(sequence, ['f', 'o', 'o']);
assert.deepStrictEqual(keys, [
{ sequence: 'f', name: 'f', ctrl: false, meta: false, shift: false },
{ sequence: 'o', name: 'o', ctrl: false, meta: false, shift: false },
{ sequence: 'o', name: 'o', ctrl: false, meta: false, shift: false }
]);
});

0 comments on commit 3de9bc9

Please sign in to comment.
You can’t perform that action at this time.