@devisfuture/mega-collection 1.1.9 → 1.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,13 +2,38 @@
|
|
|
2
2
|
<img src="./illustration.png" alt="mega-collection illustration" width="100%" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/@devisfuture/mega-collection) [](https://www.npmjs.com/package/@devisfuture/mega-collection) [](https://codecov.io/gh/trae-op/mega-collection) [](https://www.typescriptlang.org/)
|
|
5
|
+
[](https://www.npmjs.com/package/@devisfuture/mega-collection) [](https://www.npmjs.com/package/@devisfuture/mega-collection) [](https://codecov.io/gh/trae-op/mega-collection) [](https://www.typescriptlang.org/) [](https://github.com/trae-op/mega-collection)
|
|
6
|
+
|
|
7
|
+
If this package saved you some time, a ⭐ on GitHub would be much appreciated.
|
|
6
8
|
|
|
7
9
|
# @devisfuture/mega-collection
|
|
8
10
|
|
|
9
11
|
> Search, filter & sort engine for **100K+** item collections in JavaScript / TypeScript.
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
## Navigation
|
|
14
|
+
|
|
15
|
+
- [What does this package solve](#what-does-this-package-solve) – explains the core problem addressed by the library
|
|
16
|
+
- [Features](#features) – overview of package capabilities
|
|
17
|
+
- [React demo](#react-demo) – link to example app and live demo
|
|
18
|
+
- [Install](#install) – npm installation instructions
|
|
19
|
+
- [Quick Start](#quick-start) – examples for using the engines
|
|
20
|
+
- [All-in-one: `MergeEngines`](#all-in-one-mergeengines) – combine search, filter, sort
|
|
21
|
+
- [Search only](#search-only) – text search engine usage
|
|
22
|
+
- [Filter only](#filter-only) – multi-criteria filter engine
|
|
23
|
+
- [Sort only](#sort-only) – sort engine examples
|
|
24
|
+
- [API Reference](#api-reference) – detailed methods and options
|
|
25
|
+
- [`MergeEngines<T>`](#mergeenginest-root-module) – unified facade around dataset
|
|
26
|
+
- [`TextSearchEngine<T>`](#textsearchenginet-search-module) – trigram search engine
|
|
27
|
+
- [`FilterEngine<T>`](#filterenginet-filter-module) – indexed filter engine
|
|
28
|
+
- [`SortEngine<T>`](#sortenginet-sort-module) – pre-sorted comparators
|
|
29
|
+
- [Types](#types) – exported TypeScript types
|
|
30
|
+
- [Architecture](#architecture) – project structure overview
|
|
31
|
+
- [Build](#build) – build and development commands
|
|
32
|
+
- [Contributing](#contributing) – guidelines for contributors
|
|
33
|
+
- [Security](#security) – policy information
|
|
34
|
+
- [License](#license) – MIT license terms
|
|
35
|
+
|
|
36
|
+
## What does this package solve
|
|
12
37
|
|
|
13
38
|
Sometimes in projects, you need to iterate through huge collections (100K+ elements in an array) that have come from the server. Usually, the most common features are searching, filtering, and sorting.
|
|
14
39
|
So, this package helps to perform searching, filtering, and sorting of large collections faster than standard JavaScript methods. This operation is performed before rendering the UI content.
|