You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,18 @@ Blazing fast library for fuzzy filtering, matching, and other fuzzy things!
4
4
5
5
# Zadeh
6
6
7
-
Zadeh is a blazing fast library for fuzzy filtering, matching, and other fuzzy things. Zadeh is a multi-threaded library written in C++ with the goal to search through a dataset with 1M entries in a few hundred milliseconds.
7
+
Zadeh is a blazing fast library for fuzzy filtering, matching, and other fuzzy things. Zadeh is a multithreaded library written in C++ with the goal to search through a dataset with 1M entries in a few hundred milliseconds.
8
8
9
9
### features
10
10
11
-
-fuzzy filter through an array of candidates (`StringArrayFilterer`)
12
-
-fuzzy filter through nested tree-like objects (`TreeFilterer`)
11
+
-Fuzzy filter through an array of candidates (`StringArrayFilterer`)
12
+
-Fuzzy filter through nested tree-like objects (`TreeFilterer`)
13
13
- Special treatment for strings that have separators (space ``, hyphen `-`, underline`_`)
14
14
- Special treatment for path-like strings (string separated by `\` or `//`)
15
15
- give an array of indices at which the query matches the given string (`match`)
16
16
- score the given string against the given query (`score`)
17
17
- give an HTML/Markdown string that highlights the range for which the match happens (`wrap`)
18
-
- Allows setting the candidates only once using `StringArrayFilterer` and `TreeFilterer` classes, and then, perform `filter` multiple times, which is much more efficient than calling the `filter` or `filterTree` functions directly every time.
18
+
- Allows setting the candidates only once using `StringArrayFilterer` and `TreeFilterer` classes, and then perform `filter` multiple times, which is much more efficient than calling the `filter` or `filterTree` functions directly every time.
19
19
- Bindings for Nodejs (more to come)
20
20
21
21
# Usage
@@ -340,7 +340,7 @@ returns
340
340
341
341
Score the given string against the given query.
342
342
343
-
-`string` - The string the score.
343
+
-`string` - the string to score.
344
344
-`query` - The query to score the string against.
345
345
346
346
```js
@@ -424,7 +424,7 @@ Sort and filter the given candidates by matching them against the given query.
424
424
425
425
-`candidates` - An array of strings or objects.
426
426
-`query` - A string query to match each candidate against.
427
-
-`options` options. You should provide a `key` in the options if an array of objects are passed.
427
+
-`options`- the options. You should provide a `key` in the options if an array of objects is passed.
428
428
429
429
Returns an array of candidates sorted by best match against the query.
API is backward compatible with Fuzzaldrin and Fuzzaldrin-plus. Additional functions are provided to achieve better performance that could suit your needs
0 commit comments