Skip to content
Version: xstate@5.0.0

StateMachine.getInitialState() method​

Returns the initial State instance, with reference to self as an ActorRef.

Signature:

getInitialState(actorCtx: ActorContext<MachineSnapshot<TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, TEvent>, input?: TInput): MachineSnapshot<TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>;

Parameters​

ParameterTypeDescription
actorCtxActorContext<MachineSnapshot<TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, TEvent>
inputTInput(Optional)

Returns:

MachineSnapshot<TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>