Class WorkflowStateMachine<TState, TEvent, TContext>

State machine managing linear forward-only workflows. Handled via explicit events and transitions.

Type Parameters

TState
TEvent
TContext

Hierarchy (View Summary)

BaseStateMachine<TState, TContext>
- WorkflowStateMachine

Index

Constructors

Properties

context currentState history transitions

Methods

addTransition getContext getHistory getState transition updateContext

Constructors

constructor

new WorkflowStateMachine<TState, TEvent, TContext>(
initialState: TState,
context: TContext,
): WorkflowStateMachine<TState, TEvent, TContext>
Creates a workflow state machine.
Type Parameters
- TState
- TEvent
- TContext
Parameters
- initialState: TState
  Starting workflow state.
- context: TContext
  Context payload.
Returns WorkflowStateMachine<TState, TEvent, TContext>
Overrides BaseStateMachine.constructor
- Defined in StateMachine.ts:73

Properties

`Protected`context

context: TContext

`Protected`currentState

currentState: TState

`Protected`history

history: TState[] = []

`Protected`transitions

transitions: WorkflowTransition<TState, TEvent, TContext>[] = []

Methods

addTransition

addTransition(
    from: TState,
    event: TEvent,
    to: TState,
    guard?: GuardFunction<TContext>,
    action?: ActionFunction<TContext>,
): this
Registers a transition rule between two workflow states.
Parameters
- from: TState
  Origin state.
- event: TEvent
  Event triggering the change.
- to: TState
  Destination state.
- Optionalguard: GuardFunction<TContext>
  Optional guard function returning a boolean.
- Optionalaction: ActionFunction<TContext>
  Optional action callback.
Returns this
The state machine instance for chaining.
- Defined in StateMachine.ts:88

getContext

getContext(): TContext
Returns the context bound to the machine.

Returns TContext
The active context object.
Inherited from BaseStateMachine.getContext
- Defined in StateMachine.ts:37

getHistory

getHistory(): TState[]
Returns the history trace of all states traversed.

Returns TState[]
Array of state transitions.
- Defined in StateMachine.ts:128

getState

getState(): TState
Returns the active state of the machine.

Returns TState
The current state.
Inherited from BaseStateMachine.getState
- Defined in StateMachine.ts:28

transition

transition(event: TEvent): Promise<boolean>
Performs a transition to a new state if the event matches and the guard function passes.
Parameters
- event: TEvent
  The triggering event.
Returns Promise<boolean>
A promise resolving to true if the transition succeeded, false otherwise.
- Defined in StateMachine.ts:105

updateContext

updateContext(newContext: Partial<TContext>): void
Merges new properties into the state machine's execution context.
Parameters
- newContext: Partial<TContext>
  Partial context to merge.
Returns void
Inherited from BaseStateMachine.updateContext
- Defined in StateMachine.ts:46