4.1.0 • Published 3 years ago
@hfelix/spellchecker v4.1.0
SpellChecker Node Module
Native bindings to NSSpellChecker, Hunspell, or the Windows 10 Spell Check API, depending on your platform. Windows 8.1 and below as well as Linux will rely on Hunspell.
Installing
npm install spellchecker
Using
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.