flutter-dart-open-source/rx_storage

Reactive storage for Dart/Flutter. RxDart Storage for Dart/Flutter.

rx_storage

Reactive storage for Dart/Flutter. RxDart Storage for Dart/Flutter.

Author: Petrus Nguyễn Thái Học

Liked some of my work? Buy me a coffee (or more likely a beer)

Note: rx_shared_preferences is an extension of this package.

More detail about returned Stream

• It's a single-subscription Stream (ie. it can only be listened once).

• Stream will emit the value (nullable) or a TypeError as its first event when it is listen to.

• It will automatically emit value when value associated with key was changed successfully (emit null when value associated with key was removed or set to null).

• When value read from Storage has a type other than expected type:

  • If value is null, the Stream will emit null (this occurred because null can be cast to any nullable type).
  • Otherwise, the Stream will emit a TypeError.

• 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.

Key changed:  |----------K1---K2------K1----K1-----K2---------> time
              |                                                
Value stream: |-----@----@------------@-----@-----------------> time
              |    ^                                      
              |    |
              |  Listen(key=K1)
              |
              |  @: nullable value or TypeError

Usage

A simple usage example:

import 'package:rx_storage/rx_storage.dart';

class StorageAdapter implements Storage<String, void> { ... }

main() async {
  final adapter = StorageAdapter();
  final rxStorage = RxStorage<String, void>(adapter);

  rxStorage.observe('key', (v) => v as String?).listen((String? s) { ... });
  await rxStorage.write('key', 'a String', (v) => v);
  await rxStorage.read('key', (v) => v as String?);
}

Features and bugs

Please file feature requests and bugs at the issue tracker.

rx_storage's Issues

Rename `Logger` to `RxStorageLogger`

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update codecov/codecov-action action to v4
• chore(deps): update dependency lints to v4

Detected dependencies

github-actions

.github/workflows/dart.yml

• actions/checkout v4
• dart-lang/setup-dart v1.4
• codecov/codecov-action v3.1.6

pub

pubspec.yaml

• rxdart_ext ^0.2.1
• disposebag ^1.5.1
• stack_trace ^1.10.0
• lints ^1.0.1
• test ^1.17.12
• collection ^1.16.0
• dart >=2.12.0 <4.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository