Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cbbfcd/didyoumean3
super fast new didyoumean via levenshtein
https://github.com/cbbfcd/didyoumean3
Last synced: 9 days ago
JSON representation
super fast new didyoumean via levenshtein
- Host: GitHub
- URL: https://github.com/cbbfcd/didyoumean3
- Owner: cbbfcd
- License: mit
- Created: 2020-01-14T17:28:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-22T09:37:16.000Z (over 3 years ago)
- Last Synced: 2024-10-14T06:08:02.831Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://cbbfcd.github.io/didyoumean3/
- Size: 183 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# didyoumean3
[](https://nodei.co/npm/didyoumean3/)
[](https://greenkeeper.io/)
[](https://travis-ci.com/cbbfcd/didyoumean3)
## Features
- [x] Via fastest levenshtein algorithm
- [x] Custom return results
- [x] Typescript Support
- [x] Super fast 🚀
- [x] More flexible configuration
- [x] Super small and tree shaking! [more info](https://bundlephobia.com/[email protected])
## Usage
### install
```js
npm i didyoumean3
// or
yarn add didyoumean3
```
### use case
- **base use**
```js
import { didyoumean3 } from 'didyoumean3'
// or
const { default: didyoumean3 } = require('didyoumean3');
let input = 'insargrm'
let list = [
'facebook', 'INSTAgram', ' in stagram', 'baidu', 'twitter', 'wechat', 'instagram', 'linkedin'
]
console.log(didyoumean3(input, list));
// will print:
// {
// winner: 'instagram', // 🔥 This is the best match, our winner！
// matched: [
// {
// score: 8,
// target: 'facebook',
// },
// {
// score: 3,
// target: 'instagram',
// },
// {
// score: 7,
// target: 'linkedin',
// },
// // ...
// ],
// }
```
- **optional configuration**
`didyoumea3` has some built-in string formatting configuration items：
* `ignore`: Ignore case when comparing, default false.
* `trim`: Use `string.trim` format the string, default true.
* `trimAll`: Use regexp `/\s+/g` formate the string, default false.
* `diacritics`: Use `normalize` Api, e.g. 'café' -> 'café'.normalize(), default false
* `normalize`: Customize the formatting function by yourself.
> 🔥 If these parameters don't meet your requirements, you can customize the formatting function through `normalize`.
> 🔥 When using the custom normalize function, the above string formatting configurations will be ignored.
```js
didyoumean3(input, target, { normalize: (s: string) => s.trim() } );
```
---
`result`: Customize the structure of the results you want to return
```js
// default result may be null or {winner: xx, matched: []}
type Res = null | { matched: any[], winner: string }
// you can custom your own result style!!
const result = (res: Res) => {
if (!res) return 'nothing matched!'
else return res
}
didyoumean3(input, target, { result } );
```
---
`filter`: You can filter the results you want, such as those with a score greater than 5
```js
let i2 = 'insargrm';
let l2 = ['facebook', 'instagram', 'linkedin'];
expect(
didyoumean3(i2, l2, { filter: (score: number, item: any) => score >= 7 })
?.matched.length
).toBe(2);
```
---
## benchmark
```js
didyoumean x 159,428 ops/sec ±1.63% (85 runs sampled)
didyoumean2 x 227,343 ops/sec ±1.26% (90 runs sampled)
didyoumean3 x 400,683 ops/sec ±0.59% (89 runs sampled)
Fastest is didyoumean3
```
## contributors
> Both issure and pr are welcome!
## license
[MIT](./LICENSE)