find-similar
v1.2.6
Published
Finds similar word(s) in a list of words
Downloads
26
Maintainers
Readme
find-similar
Finds similar word(s) in a list of words.
Install
npm i find-similar
Usage
This package is pure ESM, please read the esm-package.
import { findSimilar, didYouMean } from 'find-similar'
console.log(findSimilar('foos', ['bar', 'baz', 'foo']))
// => ['foo']
// Suggests similar words
console.log(didYouMean('foos', ['bar', 'baz', 'foo']))
// => 'Did you mean "foo"?'
API Reference
findSimilar(word: string, candidates: readonly string[] | string[], options?: Options): string[]
Finds similar word(s) in a list of words.
word
: The word to find similar words for.candidates
: An array of words to compare against.options
: Options for the function (optional).maxScore
: Maximum levenshtein distance threshold. (default: 3)criteria
: The similarity threshold, a number between 0 and 1. (default: 0.5)prefix
: A string to prepend to the suggested word. (default: '')
Returns an array of similar words.
didYouMean(word: string, candidates: readonly string[] | string[], options?: Options): string
Suggests similar words in a list of words.
word
: The word to find similar words for.candidates
: An array of words to compare against.options
: Options for the function (optional).maxScore
: Maximum levenshtein distance threshold. (default: 3)criteria
: The similarity threshold, a number between 0 and 1. (default: 0.5)prefix
: A string to prepend to the suggested word. (default: '')
Returns a string of suggested words or an empty string if no matches are found.
Options
maxScore
: Maximum levenshtein distance threshold. (default: 3)criteria
: The similarity threshold, a number between 0 and 1. (default: 0.5)prefix
: A string to prepend to the suggested word. (default: '')
Contributing
We 💛 issues.
When committing, please conform to the semantic-release commit standards. Please install commitizen
and the adapter globally, if you have not already.
npm i -g commitizen cz-conventional-changelog
Now you can use git cz
or just cz
instead of git commit
when committing. You can also use git-cz
, which is an alias for cz
.
git add . && git cz
License
A project by Stilearning © 2022-2023.