Assign functions to keypress events
var shortcut = require('../shortcut')(process.stdin)
process.stdin.setRawMode(true)
process.stdin.resume()
// shortcut assignment
shortcut('ctrl+c', process.exit)
// multiple shortcuts bound to one function
shortcut('alt+a, shift+a, ctrl+a', function() {
console.log('awesome')
})
// get event and handler data
shortcut('b, ⇧+b, ^+b, ⌥+b', function(e, handler) {
console.log(handler.shortcut+': fired!')
})
npm install shortcut
If the ReadableStream is not emiting keypress events then the stream will be passed into keypress
Returns the shortcut library listening to ReadableStream
string: A combination of Modifiers joined by + and terminated with
a single key. You can join shortcuts with a comma , to assign multiple to
one function.fn: Will be called with the keypress event and the shortcut handlershift: ⇧, shiftctrl : ^, ctrl, controlmeta : ⌥, meta, alt, optionThis module is heavily inspired by Thomas Fuchs' keymaster library.
MIT
FAQs
Subscribe handlers to keyboard shortcuts
We found that shortcut demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.