Merge branch 'master' into deprecte-async-cache-stream
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0086e7b..1315bdc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,8 @@
* Update `StreamGroup` methods that return a `Future<dynamic>` today to return
a `Future<void>` instead.
+* Deprecated `AsyncCache.fetchStream`.
+
* Make `AsyncCache.ephemeral` invalidate itself immediately when the returned
future completes, rather than wait for a later timer event.
diff --git a/lib/src/async_cache.dart b/lib/src/async_cache.dart
index be7434f..b055182 100644
--- a/lib/src/async_cache.dart
+++ b/lib/src/async_cache.dart
@@ -31,7 +31,7 @@
/// future completes.
final Duration? _duration;
- /// Cached results of a previous [fetchStream] call.
+ /// Cached results of a previous `fetchStream` call.
StreamSplitter<T>? _cachedStreamSplitter;
/// Cached results of a previous [fetch] call.
@@ -43,7 +43,7 @@
/// Creates a cache that invalidates its contents after [duration] has passed.
///
/// The [duration] starts counting after the Future returned by [fetch]
- /// completes, or after the Stream returned by [fetchStream] emits a done
+ /// completes, or after the Stream returned by `fetchStream` emits a done
/// event.
AsyncCache(Duration duration) : _duration = duration;
@@ -80,6 +80,7 @@
///
/// Only starts counting time after the stream has been listened to,
/// and it has completed with a `done` event.
+ @Deprecated("Feature will be removed")
Stream<T> fetchStream(Stream<T> Function() callback) {
if (_cachedValueFuture != null) {
throw StateError('Previously used to cache via `fetch`');
diff --git a/test/async_cache_test.dart b/test/async_cache_test.dart
index e8ff132..4948e53 100644
--- a/test/async_cache_test.dart
+++ b/test/async_cache_test.dart
@@ -2,6 +2,8 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
+// ignore_for_file: deprecated_member_use_from_same_package
+
import 'dart:async';
import 'package:async/async.dart';
