# ctrlkit

> A simple JS interface library for interacting with CTRLKit

Latest version **0.0.2** (published 2019-10-09) · ISC license · 0 weekly downloads

## Install

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

## 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.0.2 |
| Published | 2019-10-09 |
| First published | 2019-10-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andrés Cuevo |
| Maintainers | cwervo |
| Keywords | ctrl, bci |

## Links

- npm: https://www.npmjs.com/package/ctrlkit
- Repository: https://github.com/cwervo/ctrlkit
- Homepage: https://github.com/cwervo/ctrlkit#readme
- Issues: https://github.com/cwervo/ctrlkit/issues
- npm.io page: https://npm.io/package/ctrlkit

## Recent versions

- 0.0.2 (latest) — 2019-10-09

## README

🧠 ctrlkit ✨
---

# ⚠️ THIS PROJECT IS PRE-ALPHA, EVERYTHING WILL BREAK BECAUSE I'M STILL FIGURING OUT THE API SURFACE ⚠️

Exposes a few things useful for interacting with CTRL-Labs' CTRLKit.

- A `customEvents` object — currently only contains the `fingerTapped` event (listened for as `fingertapped`)
- A `Socket` class that starts up a WebSocket. You can customize how a `CTRL.Socket` responds to data & errors using the following methods:
    - setOnOpen(onOpenFunction)
    - setOnError(onErrorFunction)
    - setOnMessage(onMessageFunction)
- Finally, a rudimentary `parseTapData` function that parses tap data for you. Eventually this should be a function support all the gestures that CTRL supports, but I'm starting small.

To install all the dependencies run:

```
npm install
```

To update the examples:

```
npm run update-docs
```

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