https://github.com/mediamonks/seng-keycodes
Contains the key codes as static values for keys on your keyboard. Useful for auto completion and readability.
https://github.com/mediamonks/seng-keycodes
keycode npm-package seng
Last synced: 16 days ago
JSON representation
Contains the key codes as static values for keys on your keyboard. Useful for auto completion and readability.
- Host: GitHub
- URL: https://github.com/mediamonks/seng-keycodes
- Owner: mediamonks
- License: mit
- Created: 2016-08-30T10:29:39.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-25T10:04:57.000Z (almost 8 years ago)
- Last Synced: 2025-09-10T19:52:33.492Z (9 months ago)
- Topics: keycode, npm-package, seng
- Language: TypeScript
- Homepage:
- Size: 189 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# seng-keycodes
Contains the key codes as static values for keys on your keyboard. Useful for auto completion and readability.
[](https://travis-ci.org/mediamonks/seng-boilerplate)
[](https://codeclimate.com/github/mediamonks/seng-boilerplate)
[](https://coveralls.io/github/mediamonks/seng-boilerplate?branch=master)
[](https://www.npmjs.com/package/seng-boilerplate)
[](https://www.npmjs.com/package/seng-boilerplate)
## Installation
```sh
yarn add seng-keycodes
```
```sh
npm i -S seng-keycodes
```
## Basic Usage
```ts
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](http://git-scm.com/downloads)
and [Node.js](http://nodejs.org/) installed.
Clone a copy of the repo:
```sh
git clone https://github.com/mediamonks/seng-keycodes.git
```
Change to the seng-keycodes directory:
```sh
cd seng-keycodes
```
Install dev dependencies:
```sh
yarn
```
Use one of the following main scripts:
```sh
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](./CONTRIBUTING.md)
## Changelog
View [CHANGELOG.md](./CHANGELOG.md)
## Authors
View [AUTHORS.md](./AUTHORS.md)
## LICENSE
[MIT](./LICENSE) © MediaMonks