Skip to content

Files

Latest commit

 

History

History
39 lines (27 loc) · 1019 Bytes

README.md

File metadata and controls

39 lines (27 loc) · 1019 Bytes

autocorrect Build Status

NPM

Finds the best matching word using the first smallest Levenshtein distance.

Usage

Default options (uses word-list as dict)

var autocorrect = require('autocorrect')()
autocorrect('mbryo') // embryo

Custom dictionary path

var path = '/usr/share/dict/words'
var autocorrect = require('autocorrect')({dictionary: path})
autocorrect('mbryo') // embryo

Custom words

var words = ['word', 'weird', 'wired']
var autocorrect = require('autocorrect')({words: words})
autocorrect('wared') // wired

Options

  • words - a list of words to use for matching
  • dictionary - path to dictionary file

Contributors