Neurotic Pumpkin Murderer

    seng-keycodes
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    seng-keycodes

    Contains the key codes as static values for keys on your keyboard. Useful for auto completion and readability.

    Travis Code Climate Coveralls npm npm

    Installation

    yarn add seng-keycodes
    npm i -S seng-keycodes

    Basic Usage

    import SengKeycodes from 'seng-keycodes';
    // import SengKeycodes from 'seng-keycodes/lib/classname';
     
    // do something with SengKeycodes

    Building

    In order to build seng-keycodes, ensure that you have Git and Node.js installed.

    Clone a copy of the repo:

    git clone https://github.com/mediamonks/seng-keycodes.git

    Change to the seng-keycodes directory:

    cd seng-keycodes

    Install dev dependencies:

    yarn

    Use one of the following main scripts:

    yarn build            # build this project 
    yarn dev              # run compilers in watch mode, both for babel and typescript 
    yarn test             # run the unit tests incl coverage 
    yarn test:dev         # run the unit tests in watch mode 
    yarn lint             # run eslint and tslint on this project 
    yarn doc              # generate typedoc documentation 

    When installing this module, it adds a pre-commit hook, that runs lint and prettier commands before committing, so you can be sure that everything checks out.

    Contribute

    View CONTRIBUTING.md

    Changelog

    View CHANGELOG.md

    Authors

    View AUTHORS.md

    LICENSE

    MIT © MediaMonks

    Install

    npm i seng-keycodes

    DownloadsWeekly Downloads

    23

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    185 kB

    Total Files

    10

    Last publish

    Collaborators

    • devmonk