Class StateMachine

Governs the tutor's high-level behavior through explicit state transitions.

const fsm = new StateMachine();
fsm.onTransition((t) => console.log(`${t.from} → ${t.to}`));
fsm.transition(TutorStateType.LISTENING);

Index

Constructors

Methods

canTransition getHistory getState onTransition transition

Constructors

constructor

new StateMachine(): StateMachine
Creates a new StateMachine starting in TutorStateType.IDLE.

Returns StateMachine
- Defined in apps/tutor/src/behavior/StateMachine.ts:102

Methods

canTransition

canTransition(to: TutorStateType): boolean
Returns true if a transition to to is valid from the current state.
Parameters
- to: TutorStateType
  The target state to check reachability for.
Returns boolean
true if the transition is allowed.
- Defined in apps/tutor/src/behavior/StateMachine.ts:137

getHistory

getHistory(): StateTransition[]
Returns the ordered history of all transitions since instantiation.

Returns StateTransition[]
Array of past StateTransitions, oldest first.
- Defined in apps/tutor/src/behavior/StateMachine.ts:155

getState

getState(): TutorState
Returns the current tutor state.

Returns TutorState
The live TutorState snapshot.
- Defined in apps/tutor/src/behavior/StateMachine.ts:111

onTransition

onTransition(cb: TransitionCallback): void
Registers a listener that fires after every successful transition.
Parameters
- cb: TransitionCallback
  Called with the StateTransition that just occurred.
Returns void
- Defined in apps/tutor/src/behavior/StateMachine.ts:146

transition

transition(
    to: TutorStateType,
    reason?: string,
    metadata?: Record<string, unknown>,
): void
Attempts to transition to a new state. Throws if the transition is not valid from the current state.
Parameters
- to: TutorStateType
  The target TutorStateType.
- Optionalreason: string
  Optional human-readable reason for logging.
- Optionalmetadata: Record<string, unknown>
  Optional metadata to attach to the new state.
Returns void
- Defined in apps/tutor/src/behavior/StateMachine.ts:123