# lightning-spell

> Spell checker and suggestions with lightning fast c++ sym spell engine.

Latest version **0.3.0** (published 2019-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install lightning-spell
pnpm add lightning-spell
yarn add lightning-spell
bun add lightning-spell
```

## 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.3.0 |
| Published | 2019-11-06 |
| First published | 2019-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=11.0.0 |
| Dependencies | 1 |
| Unpacked size | 77.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | idris elliott |
| Maintainers | idrise |
| Keywords | spell, check, dictionary, word, search, fast, fastest |

## Links

- npm: https://www.npmjs.com/package/lightning-spell
- npm.io page: https://npm.io/package/lightning-spell

## Dependencies (1)

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

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2019-11-06
- 0.2.0 — 2019-11-06
- 0.1.0 — 2019-10-29
- 0.0.7 — 2019-10-16
- 0.0.6 — 2019-10-15
- 0.0.5 — 2019-10-15
- 0.0.4 — 2019-10-14
- 0.0.3 — 2019-10-14
- 0.0.2 — 2019-10-14

## README

IN DEVELOPMENT DON'T USE !

# lightning-spell
Spell checker and suggestions with lightning fast c++ sym spell engine.

Installing

```npm install --save lightning-spell```

Usage

```
const lightningSpell = new LightningSpell("test");
const defaultWordFrequency = 1;
        
lightningSpell.createDictionaryEntry('united state', defaultWordFrequency);
lightningSpell.createDictionaryEntry('united kingdom', defaultWordFrequency);

lightningSpell.isCorrectlySpelled('united state');
// Returns true

lightningSpell.isCorrectlySpelled('united stte');
// Returns false

lightningSpell.getSuggestions('united stte');
// Returns ["united state"]

```

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