"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app.asar.unpacked/node_modules/spellchecker/README.md" (8 Mar 2017, 1520 Bytes) of archive /windows/misc/atom-windows.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

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.


npm install spellchecker


SpellChecker = require 'spellchecker'


Check if a word is misspelled.

word - String word to check.

Returns true if the word is misspelled, false otherwise.


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.


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.