# node-keys

> High level API for key codes in node.js desktop applications. (ex: process.stdin.write(keys({ ctrl: true, name: 'c'})

Latest version **0.1.5** (published 2019-04-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-keys
pnpm add node-keys
yarn add node-keys
bun add node-keys
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2019-04-11 |
| First published | 2018-04-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 371.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Sebastian Gurin |
| Maintainers | cancerberosgx |
| Keywords | keycodes, keyboard, desktop, node.js |

## Links

- npm: https://www.npmjs.com/package/node-keys
- Repository: https://github.com/cancerberoSgx/cli-driver/tree/master/packages/node-keys
- npm.io page: https://npm.io/package/node-keys

## Recent versions

- 0.1.5 (latest) — 2019-04-11
- 0.1.4 — 2019-04-11
- 0.1.3 — 2018-04-18

## README

# node-keycodes

High level API for key codes in node.js desktop applications. Examples: 

# Install

```sh
npm install --save node-keys
```

# Usage 

Return the correct unicode sequence representing given key and control combination. Supports [a-zA-Z0-9] as input characters with any combination of ctrl - meta - shift modifiers. Usage example:


```js
import {keys} from 'node-keys'

process.stdin.write(keys({ ctrl: true, name: 'c'})
```




# TODO: 

High level string-based API

```
key('ctrl+c+x')
key('ctrl+shirt+arrow_left')



 * support altgr for example the following is altgr-u y alt-u :
 *
 * ```
 * ↓ 	226 0342 0xe2
 * 134 0206 0x86
 * 147 0223 0x93
 *
 * ^[u 	 27 0033 0x1b
 * 117 0165 0x75
 * ```

---
_Source: https://npm.io/package/node-keys · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._