Skip to content

Commit c8baff5

Browse files
committed
prepare for v2.1.0
1 parent 065c465 commit c8baff5

File tree

4 files changed

+42
-6
lines changed

4 files changed

+42
-6
lines changed

CHANGELOG.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
## 2.1.0-dev.0 - TODO
1+
## 2.1.0 - TODO
22

33
- Accept `Dart SDK` versions above 3.0.
44

5-
- Refactor `executeUpdate`
6-
- Rename to `update` and convert its parameters to named parameters
5+
- Deprecated `RxStorage.executeUpdate`. It has been replaced by `update` method.
76
```dart
87
Future<void> update<T extends Object>({
98
required Key key,
@@ -13,8 +12,8 @@
1312
Options? options,
1413
})
1514
```
16-
- Move `update` method from `RxStorage` interface to a new `TransactionallyStorage` interface.
17-
- `Transformer<T>` can return a `Future<T>`.
15+
16+
- `Transformer<T>` can return a `Future<T>`.
1817
1918
- Update dependencies
2019
- `disposebag` to `^1.5.1`.

lib/src/impl/real_storage.dart

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,23 @@ class RealRxStorage<Key extends Object, Options,
332332
// Get streams (implements [RxStorage])
333333
//
334334

335+
@nonVirtual
336+
@experimental
337+
@override
338+
Future<void> executeUpdate<T extends Object>(
339+
Key key,
340+
Decoder<T?> decoder,
341+
Transformer<T?> transformer,
342+
Encoder<T?> encoder, [
343+
Options? options,
344+
]) =>
345+
update(
346+
key: key,
347+
decoder: decoder,
348+
transformer: transformer,
349+
encoder: encoder,
350+
);
351+
335352
@experimental
336353
@nonVirtual
337354
@override

lib/src/interface/rx_storage.dart

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import 'dart:async';
22

3+
import 'package:meta/meta.dart';
4+
35
import '../impl/real_storage.dart';
46
import '../logger/logger.dart';
57
import 'storage.dart';
@@ -20,6 +22,24 @@ abstract class RxStorage<Key extends Object, Options>
2022
onDispose,
2123
);
2224

25+
/// `Read–modify–write`.
26+
///
27+
/// Read value by [key], then decode with [decoder],
28+
/// then transform by [transformer],
29+
/// then encode with [encoder]
30+
/// and finally save decoded value to persistent storage.
31+
///
32+
/// Use [update] instead. It will be removed in v3.0.0.
33+
@experimental
34+
@Deprecated('Use update instead. It will be removed in v3.0.0')
35+
Future<void> executeUpdate<T extends Object>(
36+
Key key,
37+
Decoder<T?> decoder,
38+
Transformer<T?> transformer,
39+
Encoder<T?> encoder, [
40+
Options? options,
41+
]);
42+
2343
/// Return [Stream] that will emit value read from persistent storage.
2444
/// It will automatic emit value when value associated with key was changed.
2545
Stream<T?> observe<T extends Object>(Key key, Decoder<T?> decoder,

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: rx_storage
22
description: Reactive storage for Dart/Flutter. RxDart Storage for Dart/Flutter.
3-
version: 2.1.0-dev.0
3+
version: 2.1.0
44
homepage: https://github.com/Flutter-Dart-Open-Source/rx_storage.git
55
repository: https://github.com/Flutter-Dart-Open-Source/rx_storage.git
66
issue_tracker: https://github.com/Flutter-Dart-Open-Source/rx_storage/issues

0 commit comments

Comments
 (0)