Package Exports

propose

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 (propose) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

propose

Propse a word when the input word is not in the dictionary

This module can be used to propse the right command in the scenario when there is a typo or mis-spell in the command line, it looks up the given dictionary and identifies the most similar word. It can also be used in any case that the string is formed by one or a series of known words, for example URL, directory path etc.

Example

var propose = require('propose');
var dictionary = ['hello', 'world'];
var word = 'hallo';
propose(word, dictionary); //hello

Options

threshold [0~1] specifies only the word with similarity equals to or higher than that value will be returned

var propose = require('propose');
var dictionary = ['aaaaaaaa', 'baabbbb', 'ccccc'];
var word = 'ab';
propose(word, dictionary, {
    threshold: 0.5
}); // null as the most similar word does not meet the threshold value

ignoreCase [true, false] specifies whether ignore case when comparing two words

var propose = require('propose');
var dictionary = ['HELLO', 'hallo'];
var word = 'hello';
propose(word, dictionary, {
    ignoreCase: true
}); //'HELLO'

Test

Make sure mocha is installed globally

npm install mocha -g

Run npm test to run unit test

Dependencies

levenshtein-edit-distance

License

MIT