Skip to content

CAI-js/spellcheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@caijs/spellcheck

Build Status Coverage Status NPM version NPM downloads

This library perform an spell check correction based on a dictionary of frequencies.

Important: this library does not includes any dictionary, as is intended to be used as NLP support building the dictionary based on the utterances used to train.

Installation

In your project folder run:

$ npm install @caijs/spellcheck

Spell Check a word

const SpellCheck = require('@caijs/spellcheck');

const spellCheck = new SpellCheck({
  features: {
    working: 5,
    wording: 2,
    person: 5,
    other: 6
  }
});

const fixed = spellCheck.checkToken('worling', 1);
console.log(fixed); // working

The second parameter is the maximum levenshtein distance between the words. If not provided it assumes 0 so no spell checking is done. It should return "working" and not "wording" because the length is equal but the frequency of the word "working" is greater.

Spell Check an array of words

const SpellCheck = require('./src');

const spellCheck = new SpellCheck({
  features: {
    working: 5,
    wording: 2,
    person: 5,
    other: 6
  }
});

const actual = spellCheck.check(['other', 'peraon', 'is', 'worling', 'on', 'that'], 1);
console.log(actual); // [ 'other', 'person', 'is', 'working', 'on', 'that' ]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published