Interface FsmTransitionBuilder<State, Events, Context, K>

Shared transition-declaring surface used by event builders and guarded transition builders.

Supports declaring either an external transition to another state or an internal transition that stays in the current state.

interface FsmTransitionBuilder<
    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;
}

Type Parameters

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

Hierarchy

FsmTransitionBuilder
- FsmEventBuilder
- FsmGuardedTransitionBuilder

Index

Methods

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
- 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
- Defined in src/fsm-dsl.ts:131