Skip to content

Commit 0deb5d7

Browse files
authored
docs: update links (#4291)
1 parent 95c130b commit 0deb5d7

96 files changed

Lines changed: 239 additions & 239 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

website/docs/concepts2/auto_dispose.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ which can lead to memory leaks.
4949
## When is automatic disposal triggered?
5050

5151
When automatic disposal is enabled, Riverpod will track whether a provider has listeners or not.
52-
This happens by tracking [Ref.watch](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/watch.html)/[Ref.listen](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/listen.html)
52+
This happens by tracking [Ref.watch](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/watch.html)/[Ref.listen](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/listen.html)
5353
calls (and a few others).
5454

5555
When that counter reaches zero, the provider is considered "not used", and
56-
[Ref.onCancel](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/onCancel.html)
56+
[Ref.onCancel](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/onCancel.html)
5757
is triggered.
5858
At that point, Riverpod waits for one frame (cf. `await null`). If, after that frame,
5959
the provider is still not used, then the provider is destroyed and
60-
[Ref.onDispose](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/onDispose.html)
60+
[Ref.onDispose](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/onDispose.html)
6161
will be triggered.
6262
## Reacting to state disposal
6363

website/docs/concepts2/consumers.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ Riverpod offers various refactors in IDEs like VSCode and Android Studio.
105105
To enable them in your IDE, see <Link documentID="introduction/getting_started" hash="enabling-riverpod_lintcustom_lint" />
106106
:::
107107

108-
[ref]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref-class.html
109-
[consumer]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Consumer-class.html
110-
[consumerWidget]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ConsumerWidget-class.html
111-
[consumerStatefulWidget]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ConsumerStatefulWidget-class.html
112-
[consumerState]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ConsumerState-class.html
113-
[widgetref]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/WidgetRef-class.html
108+
[ref]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref-class.html
109+
[consumer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Consumer-class.html
110+
[consumerWidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ConsumerWidget-class.html
111+
[consumerStatefulWidget]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ConsumerStatefulWidget-class.html
112+
[consumerState]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ConsumerState-class.html
113+
[widgetref]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/WidgetRef-class.html

website/docs/concepts2/containers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ void main() {
3838

3939
:::note
4040
Inside tests, do not use [ProviderContainer] directly.
41-
Use [ProviderContainer.test](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderContainer/ProviderContainer.test.html) instead.
41+
Use [ProviderContainer.test](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderContainer/ProviderContainer.test.html) instead.
4242
This will automatically dispose the container when the test ends.
4343

4444
```dart
@@ -144,6 +144,6 @@ Riverpod does this for a few reasons, which come down the the same logic: "No gl
144144
optimizations.
145145

146146

147-
[ProviderContainer]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderContainer-class.html
148-
[ProviderScope]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderScope-class.html
149-
[ProviderObserver]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderObserver-class.html
147+
[ProviderContainer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderContainer-class.html
148+
[ProviderScope]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderScope-class.html
149+
[ProviderObserver]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderObserver-class.html

website/docs/concepts2/mutations.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,12 @@ by calling the [Mutation.reset] method:
109109

110110
<CodeBlock>{trimSnippet(resetting)}</CodeBlock>
111111

112-
[MutationPending]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/MutationPending-class.html
113-
[MutationError]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/MutationError-class.html
114-
[MutationSuccess]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/MutationSuccess-class.html
115-
[MutationIdle]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/MutationIdle-class.html
116-
[Mutation.reset]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/Mutation/reset.html
117-
[Mutation.run]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/Mutation/run.html
118-
[Mutation]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/experimental_mutation/Mutation-class.html
119-
[Notifier]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/riverpod/Notifier-class.html
120-
[Ref.watch]: https://pub.dev/documentation/riverpod/3.0.0-dev.18/riverpod/Ref/watch.html
112+
[MutationPending]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/MutationPending-class.html
113+
[MutationError]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/MutationError-class.html
114+
[MutationSuccess]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/MutationSuccess-class.html
115+
[MutationIdle]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/MutationIdle-class.html
116+
[Mutation.reset]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/Mutation/reset.html
117+
[Mutation.run]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/Mutation/run.html
118+
[Mutation]: https://pub.dev/documentation/riverpod/latest/experimental_mutation/Mutation-class.html
119+
[Notifier]: https://pub.dev/documentation/riverpod/latest/riverpod/Notifier-class.html
120+
[Ref.watch]: https://pub.dev/documentation/riverpod/latest/riverpod/Ref/watch.html

website/docs/concepts2/observers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If you want to change this, you will have to clone your objects before mutating
5858

5959

6060

61-
[ProviderContainer]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderContainer-class.html
62-
[ProviderScope]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderScope-class.html
63-
[ProviderObserver]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderObserver-class.html
64-
[Ref.notifyListeners]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/notifyListeners.html
61+
[ProviderContainer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderContainer-class.html
62+
[ProviderScope]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderScope-class.html
63+
[ProviderObserver]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderObserver-class.html
64+
[Ref.notifyListeners]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/notifyListeners.html

website/docs/concepts2/offline.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ To have your test use this in-memory database, you can use <Link documentID="con
156156
<AutoSnippet raw={inMemoryTest} />
157157

158158
[riverpod_sqflite]: https://pub.dev/packages/riverpod_sqflite
159-
[Storage]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/experimental_persist/Storage-class.html
160-
[AnyNotifier.persist]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/experimental_persist/NotifierPersistX/persist.html
159+
[Storage]: https://pub.dev/documentation/hooks_riverpod/latest/experimental_persist/Storage-class.html
160+
[AnyNotifier.persist]: https://pub.dev/documentation/hooks_riverpod/latest/experimental_persist/NotifierPersistX/persist.html
161161
[JsonSqFliteStorage]: https://pub.dev/documentation/riverpod_sqflite/latest/riverpod_sqflite/JsonSqFliteStorage-class.html
162-
[JsonPersist]: https://pub.dev/documentation/riverpod_annotation/3.0.0-dev.18/experimental_json_persist/JsonPersist-class.html
163-
[Storage.inMemory]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/experimental_persist/Storage/Storage.inMemory.html
162+
[JsonPersist]: https://pub.dev/documentation/riverpod_annotation/latest/experimental_json_persist/JsonPersist-class.html
163+
[Storage.inMemory]: https://pub.dev/documentation/hooks_riverpod/latest/experimental_persist/Storage/Storage.inMemory.html

website/docs/concepts2/overrides.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ In it, you can specify a list of instructions on how to override a specific prov
1818
Such "instruction" is created using your provider, combined with value methods named `overrideWithSomething`.
1919
There are a bunch of these methods available, but all of them have their name starting with `overrideWith`.
2020
This includes:
21-
- [overrideWith](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Provider/overrideWith.html)
22-
- [overrideWithValue](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/FutureProvider/overrideWithValue.html)
23-
- [overrideWithBuild](https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/StreamProvider/overrideWithBuild.html)
21+
- [overrideWith](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Provider/overrideWith.html)
22+
- [overrideWithValue](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/FutureProvider/overrideWithValue.html)
23+
- [overrideWithBuild](https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/StreamProvider/overrideWithBuild.html)
2424

2525
A typical override looks like this:
2626

website/docs/concepts2/providers.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -585,13 +585,13 @@ class Example extends StatelessWidget {
585585
}
586586
```
587587
588-
[provider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Provider-class.html
589-
[futureprovider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/FutureProvider-class.html
590-
[streamprovider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/StreamProvider-class.html
591-
[notifierprovider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/NotifierProvider-class.html
592-
[asyncnotifierprovider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/AsyncNotifierProvider-class.html
593-
[streamnotifierprovider]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/StreamNotifierProvider-class.html
594-
[ref]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref-class.html
595-
[widgetref]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/WidgetRef-class.html
596-
[providerscope]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderScope-class.html
597-
[providercontainer]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderContainer-class.html
588+
[provider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Provider-class.html
589+
[futureprovider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/FutureProvider-class.html
590+
[streamprovider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/StreamProvider-class.html
591+
[notifierprovider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/NotifierProvider-class.html
592+
[asyncnotifierprovider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/AsyncNotifierProvider-class.html
593+
[streamnotifierprovider]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/StreamNotifierProvider-class.html
594+
[ref]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref-class.html
595+
[widgetref]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/WidgetRef-class.html
596+
[providerscope]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderScope-class.html
597+
[providercontainer]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderContainer-class.html

website/docs/concepts2/refs.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -389,17 +389,17 @@ unregister();
389389
```
390390
:::
391391

392-
[Ref]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref-class.html
393-
[Ref.watch]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/watch.html
394-
[Ref.listen]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/listen.html
395-
[Ref.invalidate]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/invalidate.html
396-
[Ref.refresh]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/refresh.html
397-
[Ref.read]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/read.html
398-
[WidgetRef.listen]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/WidgetRef/listen.html
399-
[WidgetRef.listenManual]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/WidgetRef/listenManual.html
400-
[WidgetRef]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/WidgetRef-class.html
401-
[onDispose]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/onDispose.html
402-
[onCancel]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/onCancel.html
403-
[onPause]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/Ref/onPause.html
404-
[select]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/misc/ProviderListenable/select.html
405-
[ProviderSubscription]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderSubscription-class.html
392+
[Ref]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref-class.html
393+
[Ref.watch]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/watch.html
394+
[Ref.listen]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/listen.html
395+
[Ref.invalidate]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/invalidate.html
396+
[Ref.refresh]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/refresh.html
397+
[Ref.read]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/read.html
398+
[WidgetRef.listen]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/WidgetRef/listen.html
399+
[WidgetRef.listenManual]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/WidgetRef/listenManual.html
400+
[WidgetRef]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/WidgetRef-class.html
401+
[onDispose]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/onDispose.html
402+
[onCancel]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/onCancel.html
403+
[onPause]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/Ref/onPause.html
404+
[select]: https://pub.dev/documentation/hooks_riverpod/latest/misc/ProviderListenable/select.html
405+
[ProviderSubscription]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderSubscription-class.html

website/docs/concepts2/retry.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ will keep waiting until either:
152152

153153
This ensures that `await ref.watch(myProvider.future)` skips the intermediate failures.
154154

155-
[retry]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderContainer/retry.html
156-
[ProviderException]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/ProviderException-class.html
155+
[retry]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderContainer/retry.html
156+
[ProviderException]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/ProviderException-class.html
157157
[Error]: https://api.dart.dev/stable/2.19.6/dart-core/Error-class.html
158-
[FutureProvider.future]: https://pub.dev/documentation/hooks_riverpod/3.0.0-dev.18/hooks_riverpod/FutureProvider/future.html
158+
[FutureProvider.future]: https://pub.dev/documentation/hooks_riverpod/latest/hooks_riverpod/FutureProvider/future.html

0 commit comments

Comments
 (0)