# superspeller

> ![](https://i.imgur.com/uVN8IP9.png)

Latest version **1.0.2** (published 2021-01-29) · 0 weekly downloads

## Install

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

## 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.0.2 |
| Published | 2021-01-29 |
| First published | 2021-01-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.3 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Zayie Software, Inc. |
| Maintainers | nathanna |

## Links

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

## Dependencies (4)

- [fs](https://npm.io/package/fs.md) latest
- [difflib](https://npm.io/package/difflib.md) 0.2.x
- [readline](https://npm.io/package/readline.md) latest
- [iter-tools](https://npm.io/package/iter-tools.md) ^6.2.6

## Recent versions

- 1.0.2 (latest) — 2021-01-29
- 1.0.1 — 2021-01-29
- 1.0.0 — 2021-01-29

## README

![](https://i.imgur.com/uVN8IP9.png)

# SuperSpeller
A Javascript library from Zayie to spell correct your sentences using dozens of ngram/frequency dictionaries from Pluue, Google, Oxford and more.

## Installation
To use Speller, you'll need to install via source or using a package manager like [NPM](https://npmjs.com), Github NPM, Apt or Yarn.

```
gh repo clone Zayie/SuperSpeller
git clone https://github.com/zayie/superspeller

npm install superspeller
apt-get install superspeller
yarn install superspeller
```

## Initalization

Once you've installed the library and sourced it in your code, just like this. (Use whatever variable you want.)

```javascript
const SuperSpeller = require('superspeller');
const speller = new SuperSpeller(maxEditDistance, prefixLength);

// Example

const SuperSpeller = require('superspeller');
const speller = new SuperSpeller(2, 7);
```

## Usage

First you need to add your dictionary to the system, to do so you can specify a file formated like the example below or manually add each word sepretally.

```javascript
await speller.loadDictionary(file, termIndex, countIndex, keyValueSeperator);

// Example

await speller.loadDictionary("./my_dict.txt", 0, 1, " ");
```

Then once the dictionary is all loaded up, you can use it by sending a request to the function `symSpell.lookupCompound()` like so.

```javascript
speller.lookupCompound(string);
// or
speller.lookupCompound(string, editDistance);
// or
speller.lookupCompound(string, editDistance, { ignoreNonWords, transferCasing});

// Example

speller.lookupCompound("Miy eXampull straneig.");

// Example Output

[
    {
        "term":"My example string.",
        "confidence": 0.57329911293
    }
];

```

And you've got a usable output ready for processing. :\)

## Footnotes

Improvements, controbutions, and editors are welcome! Email opensource@zayie.com for more information.

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