Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AtomicStateNodeConfig<TContext, TEvent>

Type parameters

Hierarchy

Index

Properties

Optional activities

activities: SingleOrArray<Activity<TContext>>

The activities to be started upon entering the state node, and stopped upon exiting the state node.

Optional after

after: DelayedTransitions<TContext, TEvent>

The mapping (or array) of delays (in milliseconds) to their potential transition(s). The delayed transitions are taken after the specified delay in an interpreter.

Optional context

context: TContext

The initial context (extended state) of the machine.

Optional data

data: Mapper<TContext, TEvent> | PropertyMapper<TContext, TEvent>

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

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

Optional delimiter

delimiter: undefined | string

The string delimiter for serializing the path to a string. The default is "."

Optional history

history: "shallow" | "deep" | boolean | undefined

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

Optional id

id: string | undefined

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

Optional initial

initial: undefined

Optional invoke

invoke: InvokesConfig<TContext, TEvent>

The services to invoke upon entering this state node. These services will be stopped upon exiting this state node.

Optional key

key: undefined | string

The relative key of the state node, which represents its location in the overall state value. This is automatically determined by the configuration shape via the key where it was defined.

Optional meta

meta: undefined | TStateSchema extends { meta: infer D; } ? D : any

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

Optional on

on: TransitionsConfig<TContext, TEvent>

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

Optional onDone

onDone: undefined

Optional onEntry

onEntry: SingleOrArray<Action<TContext>>

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

Optional onExit

onExit: SingleOrArray<Action<TContext>>

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

Optional order

order: undefined | number

The order this state node appears. Corresponds to the implicit SCXML document order.

Optional parallel

parallel: false | undefined

Optional Private parent

parent: StateNode<TContext>

Optional states

states: undefined

Optional strict

strict: boolean | undefined

Optional type

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

Generated using TypeDoc