Skip to content

TestMachineConfig <TContext, TEvent, TTypesMeta>

Hierarchy

Index

Properties

Properties

optionalalways

always?: TransitionConfigOrTarget<TContext, TEvent, TEvent, any, any, ParameterizedObject, any>

An eventless transition that is always taken when this state node is active.

optionalcontext

context?: MachineConfig<TContext, TEvent>[context]

optionaldescription

description?: string

A text description of the state node

optionalentry

entry?: any

The action(s) to be executed upon entering the state node.

optionalexit

exit?: any

The action(s) to be executed upon exiting the state node.

optionalhistory

history?: boolean | shallow | deep

Indicates whether the state node is a history state node, and what type of history: shallow, deep, true (shallow), false (none), undefined (none)

optionalid

id?: string

The unique ID of the state node, which can be referenced as a transition target via the #id syntax.

optionalinitial

initial?: string

optionalmeta

meta?: any

The meta data associated with this state node, which will be returned in State instances.

optionalon

on?: TransitionsConfig<TContext, TEvent, any, any, ParameterizedObject, any>

The mapping of event types to their potential transition(s).

optionalonDone

onDone?: string | SingleOrArray<TransitionConfig<TContext, DoneStateEvent<unknown>, TEvent, any, any, ParameterizedObject, any>>

The potential transition(s) to be taken upon reaching a final child state node.

This is equivalent to defining a [done(id)] transition on this state node's on property.

optionaloutput

output?: NonReducibleUnknown | Mapper<TContext, TEvent, unknown, TEvent>

The output data sent with the "xstate.done.state.id" event if this is a final state node.

The output data will be evaluated with the current context and placed on the .data property of the event.

optionalstates

states?: Record<string, TestStateNodeConfig<TContext, TEvent>>

optionaltags

tags?: any

The tags for this state node, which are accumulated into the state.tags property.

optionaltype

type?: history | atomic | compound | parallel | final

The type of this state node:

  • 'atomic' - no child state nodes
  • 'compound' - nested child state nodes (XOR)
  • 'parallel' - orthogonal nested child state nodes (AND)
  • 'history' - history state node
  • 'final' - final state node

optionaltypes

types?: MachineTypes<TContext, TEvent, any, any, any, any, any, any, any, TTypesMeta>