released: 1.1.3

CHANGELOG.md

@@ -1,31 +1,37 @@
+## 1.1.3 - Aug 4, 2020
+
+-   Updated: `README.md`.
+-   Breaking change: Change `Logger`'s signature.
+    The `clear` and `dispose` methods now returns a `Future<bool>` instead of `Future<void>`.
+
 ## 1.1.2 - Apr 11, 2020
 
-- Add `disposedBy` extension method for `StreamSubscription`
-- Add `disposedBy` extension method for `Sink`
+-   Add `disposedBy` extension method for `StreamSubscription`
+-   Add `disposedBy` extension method for `Sink`
 
 ## 1.1.1+1 - Jan 26, 2020
 
-- Update `logger`
+-   Update `logger`
 
 ## 1.1.1 - Jan 22, 2020
 
-- Fix `collection` version
+-   Fix `collection` version
 
 ## 1.1.0 - Jan 22, 2020
 
-- Add `logger` that logs disposed resources
-- Minors update
-- Upgrade min sdk to `2.6.0`
+-   Add `logger` that logs disposed resources
+-   Minors update
+-   Upgrade min sdk to `2.6.0`
 
 ## 1.0.0+1 - Nov 9, 2019
 
-- Minors update
+-   Minors update
 
 ## 1.0.0 - Aug 14, 2019
 
-- Minors update
-- Add tests
+-   Minors update
+-   Add tests
 
 ## 0.0.9
 
-- Initial version, created by Stagehand
+-   Initial version, created by Stagehand

README.md

@@ -21,8 +21,12 @@ main() async {
   final subscriptions = <StreamSubscription>[];
  
   final bag = DisposeBag([...subscriptions, ...controllers]);
+
+  await Stream.value(3).listen(null).disposedBy(bag);
+  await StreamController<int>.broadcast().disposedBy(bag);
+  await StreamController<int>.broadcast(sync: true).disposedBy(bag);
+
   await bag.dispose();
-  
   print("Bag disposed. It's all good");
 }
 ```

example/disposebag_example.dart

@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:disposebag/disposebag.dart';
+import 'package:pedantic/pedantic.dart';
 
 List<dynamic> get _disposables {
   final controllers = <StreamController>[
@@ -22,9 +23,33 @@ List<dynamic> get _disposables {
 
 void main() async {
   final bag = DisposeBag(_disposables);
-  await Future.delayed(const Duration(seconds: 2));
-  await bag.dispose();
 
+  // add & addAll
+  await bag.add(Stream.value(1).listen(null));
+  await bag.addAll([
+    Stream.value(2).listen(null),
+    Stream.periodic(const Duration(seconds: 1)).listen(null),
+  ]);
+
+  // disposedBy
+  await Stream.value(3).listen(null).disposedBy(bag);
+  await StreamController<int>.broadcast().disposedBy(bag);
+  await StreamController<int>.broadcast(sync: true).disposedBy(bag);
+
+  // await before clearing
+  await Future.delayed(const Duration(seconds: 1));
+  unawaited(bag.clear());
+  unawaited(bag.clear());
+  unawaited(bag.clear());
+
+  // adding after clearing
+  await Future.delayed(const Duration(seconds: 1));
+  await Stream.periodic(const Duration(milliseconds: 100), (i) => i)
+      .listen(print)
+      .disposedBy(bag);
+
+  // await before disposing
   await Future.delayed(const Duration(seconds: 2));
-  print("Bag disposed. It's all good");
+  await bag.dispose();
+  print("Bag disposed: ${bag.isDisposed}. It's all good");
 }