Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bent10/find-similar
Finds similar word(s) in a list of words.
https://github.com/bent10/find-similar
compare comparison diff difference distance edit fuzzy leven levenshtein match matching similar similarity string suggest text
Last synced: 2 months ago
JSON representation
Finds similar word(s) in a list of words.
- Host: GitHub
- URL: https://github.com/bent10/find-similar
- Owner: bent10
- License: mit
- Created: 2022-04-27T21:49:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-22T06:21:04.000Z (3 months ago)
- Last Synced: 2024-09-28T08:17:46.376Z (3 months ago)
- Topics: compare, comparison, diff, difference, distance, edit, fuzzy, leven, levenshtein, match, matching, similar, similarity, string, suggest, text
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/find-similar
- Size: 719 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
# find-similar
Finds similar word(s) in a list of words.
## Install
```bash
npm i find-similar
```
## Usage
This package is pure ESM, please read the [esm-package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
```js
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](https://www.conventionalcommits.org/). Please install `commitizen` and the adapter globally, if you have not already.
```bash
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`.
```bash
git add . && git cz
```
## License
A project by [Stilearning](https://stilearning.com) © 2022-2023.