# @felixrieseberg/spellchecker

> Bindings to native spellchecker

Latest version **4.0.12** (published 2019-11-12) · 0 weekly downloads

## Install

```sh
npm install @felixrieseberg/spellchecker
pnpm add @felixrieseberg/spellchecker
yarn add @felixrieseberg/spellchecker
bun add @felixrieseberg/spellchecker
```

## 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 | 4.0.12 |
| Published | 2019-11-12 |
| First published | 2018-04-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 6 |
| Maintainers | felixrieseberg |

## Links

- npm: https://www.npmjs.com/package/@felixrieseberg/spellchecker
- Repository: https://github.com/felixrieseberg/node-spellchecker
- Homepage: https://github.com/felixrieseberg/node-spellchecker#readme
- Issues: https://github.com/felixrieseberg/node-spellchecker/issues
- npm.io page: https://npm.io/package/@felixrieseberg/spellchecker

## Dependencies (1)

- [nan](https://npm.io/package/nan.md) ^2.14.0

## Recent versions

- 4.0.12 (latest) — 2019-11-12
- 4.0.11 — 2019-11-12
- 4.0.10 — 2019-06-12
- 4.0.9 — 2019-05-31
- 4.0.8 — 2019-05-08
- 5.0.0 — 2018-04-17

## README

# SpellChecker Node Module [![Build Status](https://travis-ci.org/atom/node-spellchecker.svg?branch=master)](https://travis-ci.org/atom/node-spellchecker) [![Build status](https://ci.appveyor.com/api/projects/status/up294b734wagwlaw/branch/master?svg=true)](https://ci.appveyor.com/project/kevinsawicki/node-spellchecker/branch/master)

Native bindings to [NSSpellChecker](https://developer.apple.com/library/mac/#documentation/cocoa/reference/ApplicationKit/Classes/NSSpellChecker_Class/Reference/Reference.html), [Hunspell](http://hunspell.sourceforge.net/), or the [Windows 8 Spell Check API](https://msdn.microsoft.com/en-us/library/windows/desktop/hh869853(v=vs.85).aspx), depending on your platform. Windows 7 and below as well as Linux will rely on Hunspell.

## Installing

```bash
npm install spellchecker
```

## Using

```coffeescript
SpellChecker = require 'spellchecker'
```

### SpellChecker.isMisspelled(word)

Check if a word is misspelled.

`word` - String word to check.

Returns `true` if the word is misspelled, `false` otherwise.

### SpellChecker.getCorrectionsForMisspelling(word)

Get the corrections for a misspelled word.

`word` - String word to get corrections for.

Returns a non-null but possibly empty array of string corrections.

### SpellChecker.add(word)

Adds a word to the dictionary.
When using Hunspell, this will not modify the .dic file; new words must be added each time the spellchecker is created. Use a custom dictionary file.

`word` - String word to add.

Returns nothing.

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