Nukem's Possible Manifestation
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    parse-keypublic

    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, sequence: '\u0003' } 
     
    parse('shift-ctrl-c') // returns { name: 'c', ctrl: true, meta: false, shift: true, alt: false, sequence: '\u0003' } 
     
    parse('alt-c')        // returns { name: 'c', ctrl: false, meta: false, shift: false, alt: true, sequence: 'c' } 

    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.

    Keywords

    none

    install

    npm i parse-key

    Downloadsweekly downloads

    47,252

    version

    0.2.1

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar