jbenden / node-spellchecker

SpellChecker Node Module

Home Page:http://atom.github.io/node-spellchecker

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SpellChecker Node Module Build Status Build status

Native bindings to NSSpellChecker, Hunspell, or the Windows 8 Spell Check API, depending on your platform. Windows 7 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.

About

SpellChecker Node Module

http://atom.github.io/node-spellchecker

License:MIT License


Languages

Language:C++ 54.4%Language:CoffeeScript 16.2%Language:Objective-C++ 12.5%Language:Python 9.6%Language:JavaScript 5.1%Language:Objective-C 2.2%