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>

1 files changed, 30 insertions, 0 deletions

diff --git a/test/parallel/test-readline-emit-keypress-events.js b/test/parallel/test-readline-emit-keypress-events.js
new file mode 100644
index 0000000000..ddadf6d223
--- /dev/null
+++ b/test/parallel/test-readline-emit-keypress-events.js
@@ -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 }
+  ]);
+});