useMachine

Callable

• useMachine<TMachine>(machine: AreAllImplementationsAssumedToBeProvided<TMachine[__TResolvedTypesMeta]> extends true ? TMachine : [Some implementations missing, Values<{ [ K in string | number | symbol ]: Prop<Prop<TMachine[__TResolvedTypesMeta], resolved>, missingImplementations>[K] }>], options?: ActorOptions<TMachine>): { actorRef: ActorRefFrom<TMachine>; send: (event: EventFrom<TMachine>) => void; snapshot: Ref<SnapshotFrom<TMachine>> }

---

• @alias

  useActor

  ---

  Type parameters

  • TMachine: AnyStateMachine

  Parameters

  • machine: AreAllImplementationsAssumedToBeProvided<TMachine[__TResolvedTypesMeta]> extends true ? TMachine : [Some implementations missing, Values<{ [ K in string | number | symbol ]: Prop<Prop<TMachine[__TResolvedTypesMeta], resolved>, missingImplementations>[K] }>]

  • options: ActorOptions<TMachine> = {}

  Returns { actorRef: ActorRefFrom<TMachine>; send: (event: EventFrom<TMachine>) => void; snapshot: Ref<SnapshotFrom<TMachine>> }

  • actorRef: ActorRefFrom<TMachine>

  • send: (event: EventFrom<TMachine>) => void

    • • (event: EventFrom<TMachine>): void

      • Parameters

        • event: EventFrom<TMachine>

        Returns void

  • snapshot: Ref<SnapshotFrom<TMachine>>