commit | 2e35657068d70c6897d30f12a0179b5ab59b2cb2 | [log] [tgz] |
---|---|---|
author | Mohamed Hayibor <mohamedhayibor@gmail.com> | Mon Dec 19 16:07:49 2016 -0500 |
committer | Matan Lurey <matanlurey@users.noreply.github.com> | Mon Dec 19 13:07:49 2016 -0800 |
tree | 508f8b56de9b94ad8230628826e1ab9553b3ebd9 | |
parent | 3420fe41eda328c3695b25a422ab3723232b4230 [diff] |
Add more details to README (#24) * Add more details to readme * Definition of an obsersable * What's for * Examples * Set md headers to same size * Update readme from Matan's feedback
Support for detecting and being notified when an object is mutated.
An observable is a way to be notified of a continuous stream of events over time.
Some suggested uses for this library:
You may want to look at the former TC39 proposal Observe.observe, which was deprecated.
There are two general ways to detect changes:
Observable.changes
and be notified when an object changesDiffer.diff
to determine changes between two objectsOperations on Lists:
import 'package:observable/observable.dart'; void main() { var changes; ObservableList<String> list = new ObservableList<String>.from(['a', 'b', 'c']); StreamSubscription sub = list.listChanges.listen((c) => changes = c); ListChangeRecord _delta( int index, { List removed: const [], int addedCount: 0, }) { return new ListChangeRecord( list, index, removed: removed, addedCount: addedCount, ); } list.insertAll(1, ['y', 'z']); // changes == [_delta(1, addedCount: 2)] }
Diffing two maps:
import 'package:observable/observable.dart'; void main() { final map1 = { 'key-a': 'value-a', 'key-b': 'value-b-old', }; final map2 = { 'key-a': 'value-a', 'key-b': 'value-b-new', }; var diffResult = diff(map1, map2); // [ new MapChangeRecord('key-b', 'value-b-old', 'value-b-new')] }
Diffing two sets:
import 'package:observable/observable.dart'; void main() { diff( new Set<String>.from(['a', 'b']), new Set<String>.from(['a']), ); // [ new SetChangeRecord.remove('b') ] }