# is-key-combo

> checks if event is key combo

Latest version **1.1.0** (published 2023-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-key-combo
pnpm add is-key-combo
yarn add is-key-combo
bun add is-key-combo
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-02-09 |
| First published | 2017-04-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Nicolas Escalante |
| Maintainers | nescalante |
| Keywords | is, key, combo |

## Links

- npm: https://www.npmjs.com/package/is-key-combo
- Repository: https://github.com/nescalante/is-key-combo
- Homepage: https://github.com/nescalante/is-key-combo#readme
- Issues: https://github.com/nescalante/is-key-combo/issues
- npm.io page: https://npm.io/package/is-key-combo

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-02-09
- 1.0.4 — 2019-10-18
- 1.0.3 — 2017-05-03
- 1.0.2 — 2017-05-03
- 1.0.1 — 2017-04-29
- 1.0.0 — 2017-04-29

## README

# is-key-combo

[![Greenkeeper badge](https://badges.greenkeeper.io/nescalante/is-key-combo.svg)](https://greenkeeper.io/)

Do assertions on given key combos and events and returns true if match

## Install

```
npm install is-key-combo
```

## Usage

```js
const isKeyCombo = require('is-key-combo');
const isValid = isKeyCombo(event, 'cmd+a');
```

## Some sample combinations

- `cmd+a`
- `cmd+shift+esc`
- `alt+enter`

Note that `cmd` applies both for <key>Ctrl</key> and <key>⌘</key> so it will be easier to handle combinations cross platform.

## License

MIT

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