parse-key

Parses strings into key objects of the same format as the ones emitted by nodejs readline.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
parse-key
1400.2.111 years ago11 years agoMinified + gzip package size for parse-key in KB

Readme

parse-key build status
Parses strings into key objects of the same format as the ones emitted by nodejs readline.
Counter part to stringify-key.

Installation

npm i parse-key

Usage

var parse = require('parse-key');

parse('ctrl-c')       // returns { name: 'c', ctrl: true, meta: false, shift: false, alt: false }

parse('shift-ctrl-c') // returns { name: 'c', ctrl: true, meta: false, shift: true, alt: false }

parse('alt-c')        // returns { name: 'c', ctrl: false, meta: false, shift: false, alt: true }

Caveats

For completeness' sake, the alt modifier is parsed and included with the returned key although the nodejs readline does not include it in its key object nor does it have any effect when the key is emitted.