Interface FsmGuardedTransitionBuilder<State, Events, Context, K>

Builder used after one or more guards have been declared.

Supports chaining additional guards and then declaring the guarded transition.

interface FsmGuardedTransitionBuilder<
    State extends string,
    Events extends EventMap,
    Context,
    K extends EventName<Events>,
> {
    stay(
        body?: (
            t: FsmTransitionActionsBuilder<State, Events, Context, K>,
        ) => void,
    ): void;
    toState(
        target: State,
        body?: (t: FsmTransitionActionsBuilder<State, Events, Context, K>) => void,
    ): void;
    when(cond: FsmGuard<State, Events, K, Context>): this;
}

Type Parameters

State extends string
Events extends EventMap
Context
K extends EventName<Events>

Hierarchy

FsmTransitionBuilder<State, Events, Context, K>
- FsmGuardedTransitionBuilder

Index

Methods

stay toState when

Methods

stay

stay(
    body?: (
        t: FsmTransitionActionsBuilder<State, Events, Context, K>,
    ) => void,
): void
Declares an internal transition.

The machine remains in the current state; state exit and entry actions do not run. The optional body receives a FsmTransitionActionsBuilder for declaring transition actions.
Parameters
- Optionalbody: (t: FsmTransitionActionsBuilder<State, Events, Context, K>) => void
Returns void
Inherited from FsmTransitionBuilder.stay
- Defined in src/fsm-dsl.ts:140

toState

toState(
target: State,
body?: (t: FsmTransitionActionsBuilder<State, Events, Context, K>) => void,
): void
Declares an external transition to target.

The optional body receives a FsmTransitionActionsBuilder for declaring transition actions.

If target is the current state, the machine still performs an external transition: exit actions run, then transition actions, then entry actions.
Parameters
- target: State
- Optionalbody: (t: FsmTransitionActionsBuilder<State, Events, Context, K>) => void
Returns void
Inherited from FsmTransitionBuilder.toState
- Defined in src/fsm-dsl.ts:131

when

when(cond: FsmGuard<State, Events, K, Context>): this
Adds another guard to the current guarded transition.

Guards are evaluated in declaration order. All guards in the chain must pass for the transition to be selected.
Parameters
- cond: FsmGuard<State, Events, K, Context>
Returns this
- Defined in src/fsm-dsl.ts:184