createActor

Callable

• createActor<TLogic>(logic: TLogic extends AnyStateMachine ? AreAllImplementationsAssumedToBeProvided<TLogic[__TResolvedTypesMeta]> extends true ? TLogic : [Some implementations missing, Values<{ [ K in string | number | symbol ]: Prop<Prop<TLogic[__TResolvedTypesMeta], resolved>, missingImplementations>[K] }>] : TLogic, options?: ActorOptions<TLogic>): Actor<TLogic>

---

• Creates a new actor instance for the given actor logic with the provided options, if any.

  @remarks

  When you create an actor from actor logic via createActor(logic), you implicitly create an actor system where the created actor is the root actor. Any actors spawned from this root actor and its descendants are part of that actor system.

  @example

  import { createActor } from 'xstate';
  import { someActorLogic } from './someActorLogic.ts';
  
  // Creating the actor, which implicitly creates an actor system with itself as the root actor
  const actor = createActor(someActorLogic);
  
  actor.subscribe((snapshot) => {
    console.log(snapshot);
  });
  
  // Actors must be started by calling `actor.start()`, which will also start the actor system.
  actor.start();
  
  // Actors can receive events
  actor.send({ type: 'someEvent' });
  
  // You can stop root actors by calling `actor.stop()`, which will also stop the actor system and all actors in that system.
  actor.stop();

  ---

  Type parameters

  • TLogic: AnyActorLogic

  Parameters

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

    The actor logic to create an actor from. For a state machine actor logic creator, see createMachine. Other actor logic creators include fromCallback, fromEventObservable, fromObservable, fromPromise, and fromTransition.

  • optionaloptions: ActorOptions<TLogic>

    Actor options

  Returns Actor<TLogic>