Merge pull request #16 from srav001/1.0.3

1.0.3

Author: srav001

README.md

@@ -102,6 +102,14 @@ This method removes a subscriber from the subscription.
 subscription.$deleteSub(logValue);
 ```
 
+### $clearSubs
+
+Clears all subscribers. Easy for cleanup in beforeUnmount.
+
+```typescript
+subscription.$clearSubs();
+```
+
 ### $triggerSubs
 
 This method manually triggers all subscribers to the subscription. Should only be needed rarely.
@@ -154,6 +162,8 @@ mySubscription.$value = 'world';
 
 // Remove a subscriber (can be used in onBeforeUnmount or beforeRouteLeave etc)
 mySubscription.$deleteSub(mySubscriber);
+// OR to remove all subs at once.
+mySubscription.$clearSubs();
 
 // Use the readonly version of the value
 const myReadonlyValue = mySubscription.$read;
@@ -240,6 +250,7 @@ function useSubscription<T>(
 	$read: Readonly<Ref<T>>;
 	$addSub: (subscriber: (value: T) => Promise<void> | void) => void;
 	$deleteSub: (subscriber: (value: T) => Promise<void> | void) => void;
+	$clearSubs: () => void;
 	$triggerSubs: () => void;
 	$mutate: (mutator: (value: T) => T) => void;
 };
@@ -263,6 +274,7 @@ An object with the following properties (Type def above):
 - $read - A readonly reactive reference to the current value of the subscription.
 - $addSub - A method for adding a subscriber to the subscription. It can be `async`. The subscriber is a function that will be executed whenever the value of the subscription changes. It can take the new value of the subscription as its argument.
 - $deleteSub - A method for removing a subscriber from the subscription.
+- $clearSubs - A method for clearing all subscribers.
 - $triggerSubs - A method for manually triggering all subscribers. Should only be needed rarely.
 - $mutate - A method for updating the value of the subscription with a function that takes the current value as its argument and returns the new value. This should only be used for updating complex objects.