didyoumean3

Features

• Via fastest levenshtein algorithm
• Custom return results
• Typescript Support
• Super fast 🚀
• More flexible configuration
• Super small and tree shaking! more info

Usage

install

1npm i didyoumean3
2
3// or
4yarn add didyoumean3

use case

• base use

1import { didyoumean3 } from 'didyoumean3'
2// or
3const { default: didyoumean3 } = require('didyoumean3');
4
5let input = 'insargrm'
6let list = [
7  'facebook', 'INSTAgram', ' in stagram', 'baidu', 'twitter', 'wechat', 'instagram', 'linkedin'
8]
9
10console.log(didyoumean3(input, list));
11// will print:
12// {
13//   winner: 'instagram', // 🔥 This is the best match, our winner！
14//   matched: [
15//     {
16//       score: 8,
17//       target: 'facebook',
18//     },
19//     {
20//       score: 3,
21//       target: 'instagram',
22//     },
23//     {
24//       score: 7,
25//       target: 'linkedin',
26//     },
27//     // ...
28//   ],
29// }

• 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.

1didyoumean3(input, target, { normalize: (s: string) => s.trim() } );

---

result: Customize the structure of the results you want to return

1// default result may be null or {winner: xx, matched: []}
2type Res = null | { matched: any[], winner: string }
3
4// you can custom your own result style!!
5const result = (res: Res) => {
6  if (!res) return 'nothing matched!'
7  else return res
8}
9
10didyoumean3(input, target, { result } );

---

filter: You can filter the results you want, such as those with a score greater than 5

1let i2 = 'insargrm';
2let l2 = ['facebook', 'instagram', 'linkedin'];
3expect(
4  didyoumean3(i2, l2, { filter: (score: number, item: any) => score >= 7 })
5    ?.matched.length
6).toBe(2); 

---

benchmark

1didyoumean x 159,428 ops/sec ±1.63% (85 runs sampled)
2didyoumean2 x 227,343 ops/sec ±1.26% (90 runs sampled)
3didyoumean3 x 400,683 ops/sec ±0.59% (89 runs sampled)
4Fastest is didyoumean3

contributors

Both issure and pr are welcome!

license

MIT