diff --git a/packages/signals_core/lib/src/async/future.dart b/packages/signals_core/lib/src/async/future.dart index 44ed5d57..e7e737c4 100644 --- a/packages/signals_core/lib/src/async/future.dart +++ b/packages/signals_core/lib/src/async/future.dart @@ -182,6 +182,7 @@ class FutureSignal extends StreamSignal { }) : super(() => fn().asStream(), cancelOnError: true); @override + @Deprecated("Use `reload` instead.") Future refresh() async { await super.refresh(); await future; diff --git a/packages/signals_core/lib/src/async/signal.dart b/packages/signals_core/lib/src/async/signal.dart index 02bd19da..1927d221 100644 --- a/packages/signals_core/lib/src/async/signal.dart +++ b/packages/signals_core/lib/src/async/signal.dart @@ -240,6 +240,7 @@ class AsyncSignal extends Signal> } /// Refresh the future + @Deprecated("Use `reload` instead.") Future refresh() async { value = switch (value) { AsyncData data => AsyncDataRefreshing(data.value), diff --git a/packages/signals_core/lib/src/async/state.dart b/packages/signals_core/lib/src/async/state.dart index b1f6faf6..28b206d0 100644 --- a/packages/signals_core/lib/src/async/state.dart +++ b/packages/signals_core/lib/src/async/state.dart @@ -183,6 +183,7 @@ sealed class AsyncState { } /// Create a state with a value that is refreshing + @Deprecated("Use `AsyncState.dataReloading` instead.") factory AsyncState.dataRefreshing(T data) { return AsyncDataRefreshing(data); } @@ -198,6 +199,7 @@ sealed class AsyncState { } /// Create a state with an error that is refreshing + @Deprecated("Use `AsyncState.errorReloading` instead.") factory AsyncState.errorRefreshing(Object error, [StackTrace? stackTrace]) { return AsyncErrorRefreshing(error, stackTrace ?? StackTrace.current); } @@ -223,6 +225,7 @@ sealed class AsyncState { /// Returns true if the state is refreshing with a loading flag, /// has a value or error and is not the loading state + @Deprecated("Use `isReloading` instead.") bool get isRefreshing; /// Returns true if the state is reloading with having a value or error, @@ -346,6 +349,7 @@ class AsyncDataReloading extends AsyncData implements AsyncLoading { /// A loading state with a value. Signals the query conditions that led to the data /// has remained the same and is being refreshed +@Deprecated("Use `AsyncDataReloading` instead.") class AsyncDataRefreshing extends AsyncData implements AsyncLoading { /// Create a state with a value that is refreshing const AsyncDataRefreshing(super.data); @@ -354,6 +358,7 @@ class AsyncDataRefreshing extends AsyncData implements AsyncLoading { bool get isLoading => true; @override + @Deprecated("Use `isReloading` instead.") bool get isRefreshing => true; @override @@ -381,6 +386,7 @@ class AsyncData extends AsyncState { bool get isLoading => false; @override + @Deprecated("Use `isReloading` instead.") bool get isRefreshing => false; @override @@ -434,6 +440,7 @@ class AsyncErrorReloading extends AsyncError implements AsyncLoading { /// A loading state with an error. Signal the query conditions that led to the error /// has remained the same and is being refreshed. +@Deprecated("Use `AsyncErrorReloading` instead.") class AsyncErrorRefreshing extends AsyncError implements AsyncLoading { /// Create a state with an error that is refreshing const AsyncErrorRefreshing(super.error, super.stackTrace); @@ -442,6 +449,7 @@ class AsyncErrorRefreshing extends AsyncError implements AsyncLoading { bool get isLoading => true; @override + @Deprecated("Use `isReloading` instead.") bool get isRefreshing => true; @override @@ -471,6 +479,7 @@ class AsyncError extends AsyncState { bool get isLoading => false; @override + @Deprecated("Use `isReloading` instead.") bool get isRefreshing => false; @override @@ -520,6 +529,7 @@ class AsyncLoading extends AsyncState { bool get isLoading => true; @override + @Deprecated("Use `isReloading` instead.") bool get isRefreshing => false; @override diff --git a/packages/signals_core/lib/src/async/stream.dart b/packages/signals_core/lib/src/async/stream.dart index 4ebbe47d..212f4f2f 100644 --- a/packages/signals_core/lib/src/async/stream.dart +++ b/packages/signals_core/lib/src/async/stream.dart @@ -318,6 +318,7 @@ class StreamSignal extends AsyncSignal { } @override + @Deprecated("Use `reload` instead.") Future refresh() async { super.refresh(); _stream.recompute(); diff --git a/packages/signals_core/test/async/state_test.dart b/packages/signals_core/test/async/state_test.dart index 92431f6d..586d6d61 100644 --- a/packages/signals_core/test/async/state_test.dart +++ b/packages/signals_core/test/async/state_test.dart @@ -152,7 +152,7 @@ void main() { expect(value, true); }); }); - + group('pattern matching', () { test('loading', () { final s = AsyncState.loading();