ansi-keycode
v0.0.0
Published
map browser keycodes to ansi characters and escape sequences
Downloads
599
Readme
ansi-keycode
Turn browser keycodes into ansi characters and escape sequences.
example
simple repl example
$ node
> require('ansi-keycode')(97)
'a'
> require('ansi-keycode')(36) // HOME key
'\u001bOH'
> require('ansi-keycode')(220)
'\\'
browser->server
the browser forwards its decoded events to the server:
var decode = require('ansi-keycode');
var shoe = require('shoe');
var sock = shoe('/sock');
window.addEventListener('keydown', function (ev) {
var c = decode(ev);
if (c) sock.write(c);
});
and the server.js will print what is typed in the browser:
var http = require('http');
var shoe = require('shoe');
var ecstatic = require('ecstatic')(__dirname + '/static');
var server = http.createServer(ecstatic);
server.listen(8000);
var sock = shoe(function (stream) {
stream.pipe(process.stdout);
});
sock.install(server, '/sock');
methods
var decode = require('ansi-keycode')
decode(ev, opts)
Return the ansi string for ev.which
or the keycode integer ev
.
If opts.arrows
is false
, don't include escape sequences for arrow keys.
If opts.delete
is false
, don't include escape sequences for the delete key.
If opts.backspace
is false
, don't include escape sequences for the backspace
key.
install
With npm do:
npm install ansi-keycode
license
MIT