Skip to content

Commit d2031db

Browse files
committed
DOCS
1 parent 840845d commit d2031db

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
- [x] `Listenable``Stream<Listenable>`
1111
- [x] `ValueListenable<T>``ValueStream<T>`
1212

13-
## Listenable.toStream()
13+
## Usage
14+
15+
### Listenable.toStream()
1416
```dart
1517
final ChangeNotifier changeNotifier = ChangeNotifier();
1618
final Stream<ChangeNotifier> stream = changeNotifier.toStream();
@@ -20,24 +22,28 @@ changeNotifier.notifyListeners();
2022
changeNotifier.notifyListeners();
2123
```
2224

23-
## ValueListenable.toValueStream()
25+
### ValueListenable.toValueStream()
2426
```dart
2527
final ValueNotifier<int> valueNotifier = ValueNotifier(0);
26-
final ValueStream<int> stream = valueNotifier.toValueStream();
28+
final ValueListenableStream<int> stream = valueNotifier.toValueStream();
2729
stream.listen(print); // prints 1, 2
2830
2931
valueNotifier.value = 1;
3032
valueNotifier.value = 2;
3133
print(stream.value); // prints 2
3234
```
3335

34-
## ValueListenable.toValueStream(replay: true)
36+
### ValueListenable.toValueStream(replayValue: true)
3537
```dart
3638
final ValueNotifier<int> valueNotifier = ValueNotifier(0);
37-
final ValueStream<int> stream = valueNotifier.toValueStream(replay: true);
39+
final ValueListenableStream<int> stream = valueNotifier.toValueStream(replayValue: true);
3840
stream.listen(print); // prints 0, 1, 2
3941
4042
valueNotifier.value = 1;
4143
valueNotifier.value = 2;
4244
print(stream.value); // prints 2
4345
```
46+
47+
### Note
48+
- All returned Stream is **single-subscription `Stream`** (ie. it can only be listened once) and does emits any errors.
49+
- `ValueListenableStream` always has value (ie. has no error).

0 commit comments

Comments
 (0)