npm.io
0.3.0 • Published 6 years ago

lightning-spell

Licence
MIT
Version
0.3.0
Deps
1
Size
77 kB
Vulns
0
Weekly
0
Install scriptsThis package runs scripts during installation (preinstall/install/postinstall)

IN DEVELOPMENT DON'T USE !

lightning-spell

Spell checker and suggestions with lightning fast c++ sym spell engine.

Installing

npm install --save lightning-spell

Usage

const lightningSpell = new LightningSpell("test");
const defaultWordFrequency = 1;
        
lightningSpell.createDictionaryEntry('united state', defaultWordFrequency);
lightningSpell.createDictionaryEntry('united kingdom', defaultWordFrequency);

lightningSpell.isCorrectlySpelled('united state');
// Returns true

lightningSpell.isCorrectlySpelled('united stte');
// Returns false

lightningSpell.getSuggestions('united stte');
// Returns ["united state"]

Keywords