Move @ts-ignore to a JSDoc comment so it gets preserved after compila…

…tion (#2981)
statelyai · Jan 28, 2022 · edf60d6 · edf60d6
1 parent e38ee00
commit edf60d6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.changeset/sour-candles-exist.md b/.changeset/sour-candles-exist.md
@@ -0,0 +1,5 @@
+---
+'xstate': patch
+---
+
+Moved an internal `@ts-ignore` to a JSDoc-style comment to fix consuming projects that do not use `skipLibCheck`. Regular inline and block comments are not preserved in the TypeScript's emit.
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -994,7 +994,7 @@ export interface HistoryStateNode<TContext> extends StateNode<TContext> {
   target: StateValue | undefined;
 }
 
-// @ts-ignore TS complains about withConfig & withContext not being compatible here when extending StateNode
+/** @ts-ignore TS complains about withConfig & withContext not being compatible here when extending StateNode */
 export interface StateMachine<
   TContext,
   TStateSchema extends StateSchema,