Skip to content

docs: sync the Guide with the Dart S5 ready providers #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dwikiriyadi merged 1 commit into from
Oct 21, 2026
Merged

docs: sync the Guide with the Dart S5 ready providers #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/internal/development/guide/02-packages/05-adapters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ class OrderListPage extends HookConsumerWidget {
|---|---|
| `useOnOpened(onEvent, event)` | sends `event` once, in a `Future.microtask` after the first build (Riverpod forbids changing a provider during build) |
| `useEffects(effects, onEffect)` | subscribes once, cancels on unmount, and calls `onEffect` only while the context is mounted |
| `useNetworkChecker()` | rebuilds on connectivity changes (`sinew_riverpod_providers`) |
| `useNetworkChecker(checker)` | the current `NetworkStatus`, rebuilding on connectivity changes (`sinew_riverpod_providers`) |

#### `AsyncValue` conversions {#dart-asyncvalue-conversions}

Expand All @@ -337,14 +337,14 @@ extension ViewStateToAsync<T> on ViewState<T> {
#### Ready providers {#dart-ready-providers}

```dart
final sinewConfigProvider = Provider<SinewConfig>((ref) => throw StateError('Override sinewConfigProvider in your ProviderScope.'));
final refreshCallProvider = Provider<RefreshCall>((ref) => throw StateError('Override refreshCallProvider in your ProviderScope.'));
final tokenSourceProvider = Provider<TokenSource>((ref) =>
SessionTokenSource(SecureRefreshTokenStore(ref.watch(secureStoreProvider).requireValue), ref.watch(refreshCallProvider))); // after startup awaited secureStoreProvider.future
final sinewConfigProvider = Provider<SinewConfig>((ref) => throw StateError('sinewConfigProvider has no value: override it in your ProviderScope, …'));
final refreshCallProvider = Provider<RefreshCall>((ref) => throw StateError('refreshCallProvider has no value: override it …'));
final secureStoreProvider = FutureProvider<SecureStore>((ref) => SecureStore.create()); // awaited once at startup, before runApp
final keyValueStoreProvider = Provider<KeyValueStore>((ref) => KeyValueStore.create());
final refreshTokenStoreProvider = Provider<RefreshTokenStore>((ref) => SecureRefreshTokenStore(/* secureStoreProvider's value, or a StateError saying to await it */));
final tokenSourceProvider = Provider<SessionTokenSource>((ref) => SessionTokenSource(ref.watch(refreshTokenStoreProvider), ref.watch(refreshCallProvider)));
final sinewHttpProvider = Provider<Dio>((ref) => SinewHttp.dio(ref.watch(sinewConfigProvider), ref.watch(tokenSourceProvider)));
final networkCheckerProvider = Provider<NetworkChecker>((ref) { final c = NetworkChecker(); ref.onDispose(c.dispose); return c; });
// secureStoreProvider, keyValueStoreProvider, fieldCipherProvider: FutureProviders over the async factories.
// Synchronous providers that need them read `.requireValue`, so the app awaits each `.future` once at startup (before runApp).
```

### 3. API {#dart-3-api}
Expand Down
Loading