Interface FsmBuilder<State, Events, Context>

Top-level builder passed to FsmEngine.define.

Used to declare the machine's name, initial state, states, and fallback event handling.

interface FsmBuilder<State extends string, Events extends EventMap, Context> {
    fallback(
        eventOrEvents: EventName<Events> | readonly EventName<Events>[],
        body: (
            e: FsmEventBuilder<State, Events, Context, EventName<Events>>,
        ) => void,
    ): void;
    initialState(state: State): void;
    name(name: string): void;
    state(
        state: State,
        body?: (b: FsmStateBuilder<State, Events, Context>) => void,
    ): void;
}

Type Parameters

State extends string
Events extends EventMap
Context

Index

Methods

fallback initialState name state

Methods

fallback

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

Fallback rules are considered only when the current state has no matching transition for the event.

The body receives an FsmEventBuilder, the same DSL used by state event handlers.
Parameters
- eventOrEvents: EventName<Events> | readonly EventName<Events>[]
- body: (e: FsmEventBuilder<State, Events, Context, EventName<Events>>) => void
Returns void
- Defined in src/fsm-dsl.ts:65

initialState

initialState(state: State): void
Sets the initial state explicitly.

If not called, the first declared state becomes the initial state.
Parameters
- state: State
Returns void
- Defined in src/fsm-dsl.ts:35

name

name(name: string): void
Sets a human-readable name for the machine.

Used in trace output. If not set, the engine uses its default name.
Parameters
- name: string
Returns void
- Defined in src/fsm-dsl.ts:28

state

state(
state: State,
body?: (b: FsmStateBuilder<State, Events, Context>) => void,
): void
Declares a state.

The body receives a FsmStateBuilder for defining entry and exit actions and event handling for the state.
Parameters
- state: State
- Optionalbody: (b: FsmStateBuilder<State, Events, Context>) => void
Returns void
- Defined in src/fsm-dsl.ts:43