The raw config used to create the machine.
The initial extended state
The string delimiter for serializing the path to a string. The default is "."
The data sent with the "done.state.id" event if this is a final state node.
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 levelsThe unique ID of the state node.
The initial state node key.
The services invoked by this state node.
The relative key of the state node, which represents its location in the overall state value.
The root machine node.
The meta data associated with this state node, which will be returned in State instances.
The action(s) to be executed upon entering the state node.
The action(s) to be executed upon exiting the state node.
The order this state node appears. Corresponds to the implicit SCXML document order.
(DEPRECATED) Whether the state node is a parallel state node.
Use type: 'parallel' instead.
The parent state node.
The string path from the root machine node to this node.
The child state nodes.
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 nodeThe machine's own version.
The well-structured state node definition.
All the event types accepted by this state node and its descendants.
The initial State instance, which includes all actions to be executed from entering the initial state.
The mapping of events to transitions.
All the events that have transitions directly from this state node.
Excludes any inert events.
All the state node IDs of this state node and its descendant state nodes.
The target state value of the history state node, if it exists. This represents the default state value to transition to if no history value exists yet.
All the transitions that can be taken from this state node.
Retrieves state nodes from a relative path to this state node.
The relative path from this state node
Returns the leaf nodes from a state path relative to this state node.
The relative state path to retrieve the state nodes
Whether state nodes should resolve to initial child state nodes
Returns the child state node from its relative stateKey, or throws.
Returns the state node with the given stateId, or throws.
The state ID. The prefix "#" is removed.
Returns the relative state node from the given statePath, or throws.
The string or string array relative path to the state node.
Returns the state nodes represented by the current state value.
The state value or State instance
Returns true if this state node explicitly handles the given event.
The event in question
Resolves a partial state value with its full representation in this machine.
The partial state value to resolve.
Resolves the given state to a new State instance relative to this machine.
This ensures that .events and .nextEvents represent the correct values.
The state to resolve
Determines the next state given the current state and sent event.
The current State instance or state value
The event that was sent at the current state
The current context (extended state) of the current state
Clones this state machine with custom options and context.
Options (actions, guards, activities, services) to recursively merge with the existing options.
Custom context (will override predefined context)
Clones this state machine with custom context.
Custom context (will override predefined context, not recursive)
Generated using TypeDoc
The activities to be started upon entering the state node, and stopped upon exiting the state node.