Interface FsmStateBuilder<State, Events, Context>

Builder used to define a single state.

Supports entry and exit actions and event handling for the state.

interface FsmStateBuilder<
    State extends string,
    Events extends EventMap,
    Context,
> {
    event(
        eventOrEvents: EventName<Events> | readonly EventName<Events>[],
        body: (
            e: FsmEventBuilder<State, Events, Context, EventName<Events>>,
        ) => void,
    ): void;
    onEnter(
        action: FsmEntryAction<State, Events, EventName<Events>, Context>,
    ): void;
    onExit(
        action: FsmExitAction<State, Events, EventName<Events>, Context>,
    ): void;
}

Type Parameters

State extends string
Events extends EventMap
Context

Index

Methods

event onEnter onExit

Methods

event

event(
    eventOrEvents: EventName<Events> | readonly EventName<Events>[],
    body: (
        e: FsmEventBuilder<State, Events, Context, EventName<Events>>,
    ) => void,
): void
Declares event handling for one or more events in this state.

The body receives an FsmEventBuilder for declaring begin actions, guards, and transitions.
Parameters
- eventOrEvents: EventName<Events> | readonly EventName<Events>[]
- body: (e: FsmEventBuilder<State, Events, Context, EventName<Events>>) => void
Returns void
- Defined in src/fsm-dsl.ts:111

onEnter

onEnter(action: FsmEntryAction<State, Events, EventName<Events>, Context>): void
Adds an entry action for this state.

Entry actions run when the machine enters the state. Multiple entry actions are allowed and run in declaration order.

See FsmEntryAction for the action function type signature.
Parameters
- action: FsmEntryAction<State, Events, EventName<Events>, Context>
Returns void
- Defined in src/fsm-dsl.ts:82

onExit

onExit(action: FsmExitAction<State, Events, EventName<Events>, Context>): void
Adds an exit action for this state.

Exit actions run when the machine leaves the state. Multiple exit actions are allowed and run in declaration order.

See FsmExitAction for the action function type signature.
Parameters
- action: FsmExitAction<State, Events, EventName<Events>, Context>
Returns void
- Defined in src/fsm-dsl.ts:92