!!! Important note !!!

This is a fork of node-spellchecker, you probably want that one instead because it supports Windows 7 and Linux (via Hunspell). This one removes Hunspell due to issues my org has with it's license.

SpellChecker Node Module

Native bindings to NSSpellChecker or the Windows 8 Spell Check API, depending on your platform.

Installing

npm install @ccnokes/spellchecker

Using

import { SpellChecker } from '@ccnokes/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.checkSpelling(corpus)

Identify misspelled words in a corpus of text.

corpus - String corpus of text to spellcheck.

Returns an Array containing {start, end} objects that describe an index range within the original String that contains a misspelled word.

SpellChecker.checkSpellingAsync(corpus)

Asynchronously identify misspelled words.

corpus - String corpus of text to spellcheck.

Returns a Promise that resolves with the Array described by checkSpelling().

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.

SpellChecker.isSupported()

Tells if your platform is supported. If it's not, you can use the API as normal, just nothing will actually work.

Returns boolean.