Marked all phantom properties on the StateMachine type as deprecated (

#2982)
statelyai · Jan 28, 2022 · a391455 · a391455
1 parent edf60d6
commit a391455
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.changeset/rich-tips-dress.md b/.changeset/rich-tips-dress.md
@@ -0,0 +1,5 @@
+---
+'xstate': patch
+---
+
+Marked all phantom properties on the `StateMachine` type as deprecated. This deprioritized them in IDEs so they don't popup as first suggestions during property access.
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1048,12 +1048,19 @@ export interface StateMachine<
     TResolvedTypesMeta
   >;
 
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TContext: TContext;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TStateSchema: TStateSchema;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TEvent: TEvent;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TTypestate: TTypestate;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TAction: TAction;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TServiceMap: TServiceMap;
+  /** @deprecated an internal property acting as a "phantom" type, not meant to be used at runtime */
   __TResolvedTypesMeta: TResolvedTypesMeta;
 }