fix: subscription closed does not comply with proposal (#151)

Co-authored-by: Phil Pluckthun <phil@kitten.sh>
0no-co · Mar 18, 2023 · 95c15e7 · 95c15e7
1 parent 990c8da
commit 95c15e7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/five-rules-bow.md b/.changeset/five-rules-bow.md
@@ -0,0 +1,5 @@
+---
+'wonka': patch
+---
+
+Make `closed: boolean` on `ObservableSubscription`s a required field to comply with the Observable proposal's type spec.
diff --git a/src/observable.ts b/src/observable.ts
@@ -26,7 +26,7 @@ interface ObservableSubscription {
    *
    * @readonly
    */
-  closed?: boolean;
+  closed: boolean;
   /** Cancels the subscription.
    * @remarks
    * This cancels the ongoing subscription and the {@link ObservableObserver}'s callbacks will
@@ -76,7 +76,7 @@ interface ObservableLike<T> {
    * @see {@link ObservableObserver} for the callbacks in an object that are called as Observables
    * issue events.
    */
-  subscribe(observer: ObservableObserver<T>): ObservableSubscription;
+  subscribe(observer: ObservableObserver<T>): { unsubscribe(): void };
 
   /** The well-known symbol specifying the default ES Observable for an object. */
   [Symbol.observable]?(): Observable<T>;