StateDefinition

Defined in: StateMachine.ts:75

One state in a StateMachine transition table.

Type Parameters

S

S extends string

Properties

enter?

readonly optional enter?: (transition) => void

Defined in: StateMachine.ts:86

Called after this state becomes current.

Parameters

transition

StateTransition<NoInfer<S>> | null

Returns

void

---

exit?

readonly optional exit?: (transition) => void

Defined in: StateMachine.ts:88

Called before this state stops being current.

Parameters

transition

StateTransition<NoInfer<S>>

Returns

void

---

for?

readonly optional for?: number | (() => number)

Defined in: StateMachine.ts:82

Seconds before the machine enters next. A function is called each time the state is entered, and must return a finite number above 0.

---

fromAny?

readonly optional fromAny?: boolean

Defined in: StateMachine.ts:102

Whether every other state may enter this one without declaring it in to. For the handful of states a whole machine falls into, such as hit or die. It adds no edge from this state to itself.

---

next?

readonly optional next?: NoInfer<S>

Defined in: StateMachine.ts:84

State entered when for elapses. Must be one this state can reach.

---

start?

readonly optional start?: NoInfer<S>

Defined in: StateMachine.ts:96

Child entered with this state. Required when states is declared.

---

states?

readonly optional states?: Readonly<{ [K in string]?: ChildStateDefinition<S> }>

Defined in: StateMachine.ts:94

Phases of this state, named in the same union as every other state. The machine is in exactly one of them while this state is current. Nesting is one level deep.

---

to?

readonly optional to?: readonly NoInfer<S>[]

Defined in: StateMachine.ts:77

States reachable from this one with StateMachine.go.