Fix IReactionDisposer and IIsObservableObject Typing (#3816)

* fix IReaction type * add changeset * fix IIsObservableObject too * fix test
mobxjs · Mar 28, 2024 · b28e0eb · b28e0eb
1 parent 7bbb523
commit b28e0eb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/.changeset/seven-rules-add.md b/.changeset/seven-rules-add.md
@@ -0,0 +1,5 @@
+---
+"mobx": patch
+---
+
+Fix `IReactionDisposer` and `IIsObservableObject` interface definition so that Typescript knows the property key `$mobx` is a symbol and not a string
diff --git a/packages/mobx/src/core/reaction.ts b/packages/mobx/src/core/reaction.ts
@@ -18,7 +18,8 @@ import {
     spyReportStart,
     startBatch,
     trace,
-    trackDerivedFunction, GenericAbortSignal
+    trackDerivedFunction,
+    GenericAbortSignal
 } from "../internal"
 
 /**
@@ -47,7 +48,7 @@ export interface IReactionPublic {
 
 export interface IReactionDisposer {
     (): void
-    $mobx: Reaction
+    [$mobx]: Reaction
 }
 
 export class Reaction implements IDerivation, IReactionPublic {

diff --git a/packages/mobx/src/types/observableobject.ts b/packages/mobx/src/types/observableobject.ts
@@ -629,7 +629,7 @@ export class ObservableObjectAdministration
         this.keysAtom_.reportChanged()
     }
 
-    ownKeys_(): ArrayLike<string | symbol> {
+    ownKeys_(): Array<string | symbol> {
         this.keysAtom_.reportObserved()
         return ownKeys(this.target_)
     }
@@ -647,7 +647,7 @@ export class ObservableObjectAdministration
 }
 
 export interface IIsObservableObject {
-    $mobx: ObservableObjectAdministration
+    [$mobx]: ObservableObjectAdministration
 }
 
 export function asObservableObject(