Skip to content

Commit 83fd123

Browse files
authored
Update README.md
1 parent a5a1992 commit 83fd123

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Reactive storage for Dart/Flutter. RxDart Storage for Dart/Flutter.
1414
## Note: [rx_shared_preferences](https://github.com/hoc081098/rx_shared_preferences) is an extension of this package.
1515

1616
## More detail about returned `Stream`
17+
1718
- It's a **single-subscription `Stream`** (ie. it can only be listened once).
1819

1920
- `Stream` will emit the **value (nullable)** or **a `TypeError`** as its first event when it is listen to.
2021

21-
- It will automatic emits value when value associated with key was changed successfully
22+
- It will automatically emit value when value associated with key was changed successfully
2223
(**emit `null`** when value associated with key was `removed` or set to `null`).
2324

2425
- When value read from Storage has a type other than expected type:
@@ -27,10 +28,10 @@ Reactive storage for Dart/Flutter. RxDart Storage for Dart/Flutter.
2728

2829
- **Can emit** two consecutive data events that are equal. You should use Rx operator like `distinct` (More commonly known as `distinctUntilChanged` in other Rx implementations) to create an `Stream` where data events are skipped if they are equal to the previous data event.
2930

30-
```
31-
Key changed: |----------K1---K2------K1----K1-----K2---------
31+
```text
32+
Key changed: |----------K1---K2------K1----K1-----K2---------> time
3233
|
33-
Value stream: |-----@----@------------@-----@-----------------
34+
Value stream: |-----@----@------------@-----@-----------------> time
3435
| ^
3536
| |
3637
| Listen(key=K1)

0 commit comments

Comments
 (0)