Package Exports
- typo-js
- typo-js/typo.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typo-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
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.