Deprecate interpreter.state

statelyai · Sep 5, 2022 · 6fdaae7 · 6fdaae7
1 parent 2b44a4d
commit 6fdaae7
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/.changeset/gold-kiwis-mate.md b/.changeset/gold-kiwis-mate.md
@@ -0,0 +1,5 @@
+---
+'xstate': patch
+---
+
+Reading state directly from ~~`someService.state`~~ is deprecated. Use `someService.getSnapshot()` instead.
diff --git a/packages/core/src/interpreter.ts b/packages/core/src/interpreter.ts
@@ -271,6 +271,9 @@ export class Interpreter<
       return this._initialState;
     });
   }
+  /**
+   * @deprecated Use `.getSnapshot()` instead.
+   */
   public get state(): State<
     TContext,
     TEvent,

diff --git a/packages/xstate-react/src/useMachine.ts b/packages/xstate-react/src/useMachine.ts
@@ -76,7 +76,7 @@ export function useMachine<TMachine extends AnyStateMachine>(
         : service.machine.initialState) as State<any, any, any, any, any>;
     }
 
-    return service.state;
+    return service.getSnapshot();
   }, [service]);
 
   const isEqual = useCallback(

diff --git a/packages/xstate-react/src/utils.ts b/packages/xstate-react/src/utils.ts
@@ -20,7 +20,7 @@ export function partition<T, A extends T, B extends T>(
 export function getServiceSnapshot<
   TService extends Interpreter<any, any, any, any>
 >(service: TService): TService['state'] {
-  return service.status !== 0 ? service.state : service.machine.initialState;
+  return service.getSnapshot();
 }
 
 // From https://github.com/reduxjs/react-redux/blob/master/src/utils/shallowEqual.ts