HistoryStateNode <TContext>
Hierarchy
- StateNode<TContext>
- HistoryStateNode
Index
Properties
publicoptionalalways
publicconfig
publicoptionaldescription
publicentry
The action(s) to be executed upon entering the state node.
publicexit
The action(s) to be executed upon exiting the state node.
history
The type of history on this state node. Can be:
'shallow'- recalls only top-level historical state value'deep'- recalls historical state value at all levels
publicid
The unique ID of the state node.
publickey
The relative key of the state node, which represents its location in the overall state value.
publicmachine
The root machine node.
publicoptionalmeta
The meta data associated with this state node, which will be returned in State instances.
publicorder
The order this state node appears. Corresponds to the implicit document order.
publicoptionaloutput
The output data sent with the "xstate.done.state.id" event if this is a final state node.
publicoptionalparent
The parent state node.
publicpath
The string path from the root machine node to this node.
publicstates
The child state nodes.
publictags
target
publictransitions
publictype
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
Accessors
publicafter
Returns DelayedTransitionDefinition<TContext, TEvent>[]
publicdefinition
The well-structured state node definition.
Returns StateNodeDefinition<TContext, TEvent>
publicevents
All the event types accepted by this state node and its descendants.
Returns EventDescriptor<TEvent>[]
publicinitial
Returns InitialTransitionDefinition<TContext, TEvent>
publicinvoke
The logic invoked as actors by this state node.
Returns InvokeDefinition<TContext, TEvent, ProvidedActor, ParameterizedObject, ParameterizedObject, string>[]
publicon
The mapping of events to transitions.
Returns TransitionDefinitionMap<TContext, TEvent>
publicownEvents
All the events that have transitions directly from this state node.
Excludes any inert events.
Returns EventDescriptor<TEvent>[]
Methods
public_initialize
Returns void
publicnext
Parameters
snapshot: MachineSnapshot<TContext, EventObject, any, any, any, any>
event: EventObject
Returns undefined | TransitionDefinition<TContext, EventObject>[]
publictoJSON
Returns StateNodeDefinition<TContext, EventObject>
The raw config used to create the machine.