npm.io
1.0.0 • Published 7 years ago

readkey

Licence
ISC
Version
1.0.0
Deps
0
Size
2 kB
Vulns
0
Weekly
0
Stars
1

readkey

A simple node key listener to read keys pressed on keyboard.

Usage

Create a config object with:

  • fn: the function that evaluates if the key has been pressed.
  • command: the command executed if fn() returns true

Send it to readkey();

const readkey = require('readkey');
const keyCommands = [
  { fn: (str, key) => str === 'p', command: () => console.log('p was pressed') },
  { fn: (str, key) => key.ctrl && key.name === 'c', command: () => process.exit() },
  { fn: (str, key) => key.name === 'q', command: () => process.exit() },
];
readkey(keyCommands);

Keywords