@fireflysemantics/slice 17.0.6 → 17.0.8
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 +26 -22
- package/package.json +1 -1
package/README.md
CHANGED
@@ -2,16 +2,36 @@
|
|
2
2
|
|
3
3
|
# @fireflysemantics/slice
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
If you like the [@fireflysemantics/slice API](https://fireflysemantics.github.io/slice/doc/) please star our [Github Repository](https://github.com/fireflysemantics/slice).
|
5
|
+
## TOC
|
8
6
|
|
7
|
+
- [Overview](#overview)
|
9
8
|
- [Install](#install)
|
10
9
|
- [Object Store Core Use Cases](#object-store-core-use-cases)
|
11
10
|
- [Entity Store Core Use Cases](#entity-store-core-use-cases)
|
12
11
|
- [Features](#features)
|
13
12
|
- [Documentatino and Media](#firefly-semantics-slice-development-center-media-and-documentation)
|
14
13
|
|
14
|
+
## Overview
|
15
|
+
|
16
|
+
Lightweight Javascript Reactive State Management for Angular Applications.
|
17
|
+
|
18
|
+
The API is designed to be as minimal as possible and should deliver the same features as other comparable frameworks with about 1/3 the lines of code.
|
19
|
+
|
20
|
+
It offers two types of reactive data stores:
|
21
|
+
- REST like API for performing state operations
|
22
|
+
- Entity stores (EStore<E>) for structured entity like data (Customer, Product, User, ...)
|
23
|
+
- Entity stores can be "Live filtered" by adding slices. For example separating Todo entities into complete and incomplete compartments. Slices are also obserable.
|
24
|
+
- Object store (Key value store) for unstructured data
|
25
|
+
|
26
|
+
Even though Angular is used for prototype applications, it should work well in general for:
|
27
|
+
- Single page applications
|
28
|
+
- Progressive web applications
|
29
|
+
- Node applications / Pure Javascript Applications
|
30
|
+
- Mobile Applications
|
31
|
+
|
32
|
+
If you like the [@fireflysemantics/slice API](https://fireflysemantics.github.io/slice/doc/) please star our [Github Repository](https://github.com/fireflysemantics/slice).
|
33
|
+
|
34
|
+
|
15
35
|
# Install
|
16
36
|
|
17
37
|
|
@@ -34,6 +54,8 @@ npm i @fireflysemantics/slice@lastest nanoid
|
|
34
54
|
|
35
55
|
# Usage
|
36
56
|
|
57
|
+
The project [typedoc](https://fireflysemantics.github.io/slice/typedoc/), in addition to providing more detailed API insight, syntax highlights all the examples provided here, thus you may want to check it out for a richer reading experience.
|
58
|
+
|
37
59
|
## Object Store Core Use Cases
|
38
60
|
|
39
61
|
[Here is a link to the Stackblitz Demo](https://stackblitz.com/edit/typescript-9snt67?file=index.ts)
|
@@ -508,28 +530,10 @@ store.isEmpty().subscribe((empty) => {
|
|
508
530
|
|
509
531
|
# API Documentation
|
510
532
|
|
511
|
-
See [Typedoc API Documentation](https://fireflysemantics.github.io/slice/
|
533
|
+
See [Typedoc API Documentation](https://fireflysemantics.github.io/slice/typedoc/)
|
512
534
|
|
513
535
|
The documentation for the API includes simple examples of how to apply the API to a use case.
|
514
536
|
|
515
|
-
# Overview
|
516
|
-
|
517
|
-
Lightweight Reactive Server, Mobile, and Web Application State Management Built with `RxJS` and `Typescript`.
|
518
|
-
|
519
|
-
The API is designed to be as minimal as possible and should deliver the same features as other comparable frameworks with about 1/3 the lines of code.
|
520
|
-
|
521
|
-
It offers two types of reactive data stores:
|
522
|
-
- Entity stores (EStore<E>) for structured entity like data (Customer, Product, User, ...)
|
523
|
-
- Entity stores can be "Live filtered" by adding slices. For example separating Todo entities into complete and incomplete compartments. Slices are also obserable.
|
524
|
-
- Object store (Key value store) for unstructured data
|
525
|
-
|
526
|
-
Even though Angular is used for prototype applications, it should work well for:
|
527
|
-
- Single page applications
|
528
|
-
- Progressive web applications
|
529
|
-
- React applications
|
530
|
-
- Node applications / Pure Javascript Applications
|
531
|
-
- Mobile Applications
|
532
|
-
|
533
537
|
## Build
|
534
538
|
|
535
539
|
Run `npm run c` to build the project. The build artifacts will be stored in the `dist/` directory.
|