# winkeys

> Native virtual key input functionality for Windows

Latest version **0.1.3** (published 2021-04-30) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install winkeys
pnpm add winkeys
yarn add winkeys
bun add winkeys
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2021-04-30 |
| First published | 2019-05-08 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Alan Litz |
| Maintainers | ajlitz |

## Links

- npm: https://www.npmjs.com/package/winkeys
- Repository: https://git.alitz.us/alan/WinKey
- npm.io page: https://npm.io/package/winkeys

## Dependencies (1)

- [node-addon-api](https://npm.io/package/node-addon-api.md) ^3.1.0

## Recent versions

- 0.1.3 (latest) — 2021-04-30
- 0.1.2 — 2021-04-30
- 0.1.1 — 2019-05-10
- 0.1.0 — 2019-05-08

## README

WinKeys
======

WinKeys is designed to do one thing: send native keyboard inputs to Windows. 

I was developing a very niche Electron application and robotjs was not yet updated to support Node 12 / Electron 5. It will not work on anything except Windows, and I have no plans to add support for other platforms in the future.

## Usage

> const winkeys = require("winkeys");
>
> winkeys.pressKeys(string);

You may send one character at a time, or a whole string (can include spaces).
There are special keys which require the use of specific codes:

| Physical Key | Special Code |
|--------------|--------------|
| Enter/Return | @@return     |
| Backspace    | @@backspace  |
| Control      | @@control    |
| Space Bar    | @@space      |
| Delete       | @@delete     |
| Tab          | @@tab        |

These codes must be sent by themselves, and not in the middle of another string.

>winkeys.pressKeys("@@backspace");

Other special keys may be added in the future as they are fairly trivial to implement. If you need one added, feel free to submit a Pull Request or create a Feature Request under Issues.

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