typo-js

Typo.js is a JavaScript/TypeScript spellchecker that uses Hunspell-style dictionaries.

Usage

To use Typo, simply load it like so:

var Typo = require("typo-js");
var dictionary = new Typo(lang_code);

Typo includes by default a dictionary for the en_US lang_code.

To check if a word is spelled correctly, do this:

var is_spelled_correctly = dictionary.check("mispelled");

To get suggested corrections for a misspelled word, do this:

var array_of_suggestions = dictionary.suggest("mispeling");

// array_of_suggestions == ["misspelling", "dispelling", "misdealing", "misfiling", "misruling"]

Typo.js has full support for the following Hunspell affix flags:

• PFX
• SFX
• REP
• FLAG
• COMPOUNDMIN
• COMPOUNDRULE
• ONLYINCOMPOUND
• KEEPCASE
• NOSUGGEST
• NEEDAFFIX

It also supports the Typo-specific flag PRIORITYSUGGEST. This allows you to specify that certain words should be given priority in the suggestions list when correcting a mispelled word. If you add the following to your .aff file (ideally on the line after NOSUGGEST):

PRIORITYSUGGEST @

and then add the @ flag to your new words in your .dic file, like

skibidi/@
rizz/@

then those words will be prioritized above other suggestions if they already appear in the suggestions list.

Development

The full TypeScript source code and unit test suites are available in the official Typo.js repository at https://github.com/cfinke/Typo.js

To modify Typo.js, make your changes to ts/typo.ts and then run build.sh to generate the JavaScript file typo/typo.js.

Licensing

Typo.js is free software, licensed under the Modified BSD License.