feat: restrict invoked subscribable to eventobject

BREAKING Signed-off-by: Wouter Termont <woutermont@gmail.com>
statelyai · Apr 15, 2021 · 18789aa · 18789aa
1 parent 14cdef6
commit 18789aa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/.changeset/gorgeous-kiwis-drive.md b/.changeset/gorgeous-kiwis-drive.md
@@ -0,0 +1,13 @@
+---
+'xstate': major
+---
+
+This update restricts invoked `Subscribable`s to `EventObject`s,
+so that type inference can be done on which `Subscribable`s are
+allowed to be invoked.
+
+Existing `MachineConfig`s that invoke `Subscribable`s that are not
+`Subscribable<EventObject>`s should be updated accordingly:
+either their emissions are desired, and should thus be acted on
+as events, or they are not, in which case an action would
+probably be a better choice than a service.
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -264,7 +264,7 @@ export type InvokeCreator<
 ) =>
   | PromiseLike<TFinalContext>
   | StateMachine<TFinalContext, any, any>
-  | Subscribable<any>
+  | Subscribable<EventObject>
   | InvokeCallback;
 
 export interface InvokeDefinition<TContext, TEvent extends EventObject>