uē-tôo

日本語

English
繁體中文

日本語

English
繁體中文

外観

v0.18 のドキュメントを表示しています。最新バージョンは v0.20 です。 最新のドキュメントへ

@ue-too/being / index / TemplateStateMachine

クラス: TemplateStateMachine<EventPayloadMapping, Context, States, EventOutputMapping> ​

定義: interface.ts:665

Concrete implementation of a finite state machine.

Remarks ​

This class provides a complete, ready-to-use state machine implementation. It's generic enough to handle most use cases without requiring custom extensions.

Features ​

  • Type-safe events: Events and their payloads are fully typed via the EventPayloadMapping
  • State transitions: Automatic state transitions based on event handlers
  • Event outputs: Handlers can return values that are included in the result
  • Lifecycle hooks: States can define uponEnter and beforeExit callbacks
  • State change listeners: Subscribe to state transitions
  • Shared context: All states access the same context object for persistent data

Usage Pattern ​

  1. Define your event payload mapping type
  2. Define your states as a string union type
  3. Create state classes extending TemplateState
  4. Instantiate TemplateStateMachine with your states and initial state

例 ​

Basic vending machine state machine

typescript
type Events = {
  insertCoin: { amount: number };
  selectItem: { itemId: string };
  cancel: {};
};

type States = "IDLE" | "PAYMENT" | "DISPENSING";

interface VendingContext extends BaseContext {
  balance: number;
  setup() { this.balance = 0; }
  cleanup() {}
}

const context: VendingContext = {
  balance: 0,
  setup() { this.balance = 0; },
  cleanup() {}
};

const machine = new TemplateStateMachine<Events, VendingContext, States>(
  {
    IDLE: new IdleState(),
    PAYMENT: new PaymentState(),
    DISPENSING: new DispensingState()
  },
  "IDLE",
  context
);

// Trigger events
machine.happens("insertCoin", { amount: 100 });
machine.happens("selectItem", { itemId: "A1" });

参照 ​

によって拡張された ​

型パラメーター ​

EventPayloadMapping ​

EventPayloadMapping

Object mapping event names to their payload types

Context ​

Context extends BaseContext

Context type shared across all states

States ​

States extends string = "IDLE"

Union of all possible state names (string literals)

EventOutputMapping ​

EventOutputMapping extends Partial<Record<keyof EventPayloadMapping, unknown>> = DefaultOutputMapping<EventPayloadMapping>

Optional mapping of events to their output types

実装 ​

  • StateMachine<EventPayloadMapping, Context, States, EventOutputMapping>

コンストラクター ​

コンストラクター ​

new TemplateStateMachine<EventPayloadMapping, Context, States, EventOutputMapping>(states, initialState, context, autoStart): TemplateStateMachine<EventPayloadMapping, Context, States, EventOutputMapping>

定義: interface.ts:701

パラメータ ​

states ​

Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

initialState ​

States

context ​

Context

autoStart ​

boolean = true

戻り値 ​

TemplateStateMachine<EventPayloadMapping, Context, States, EventOutputMapping>

プロパティ ​

_context ​

protected _context: Context

定義: interface.ts:683

_currentState ​

protected _currentState: "INITIAL" | "TERMINAL" | States

定義: interface.ts:678

_eventResultCallbacks ​

protected _eventResultCallbacks: EventResultCallback<EventPayloadMapping, Context, States>[]

定義: interface.ts:693

_happensCallbacks ​

protected _happensCallbacks: (args, context) => void[]

定義: interface.ts:686

パラメータ ​

args ​

EventArgs<EventPayloadMapping, string> | EventArgs<EventPayloadMapping, keyof EventPayloadMapping>

context ​

Context

戻り値 ​

void

_initialState ​

protected _initialState: States

定義: interface.ts:699

_stateChangeCallbacks ​

protected _stateChangeCallbacks: StateChangeCallback<States>[]

定義: interface.ts:685

_states ​

protected _states: Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

定義: interface.ts:679

_statesArray ​

protected _statesArray: States[]

定義: interface.ts:684

_timeouts ​

protected _timeouts: number | undefined = undefined

定義: interface.ts:698

アクセッサー ​

context ​

署名を取得する ​

get context(): Context

定義: interface.ts:874

Read-only access to the machine's live context object. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Intended for tooling/introspection (e.g. visualizers evaluating guards against the current context) — mutate state through events, not through this reference.

戻り値 ​

Context

Read-only access to the machine's live context object. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Intended for tooling/introspection (e.g. visualizers evaluating guards against the current context) — mutate state through events, not through this reference.

の実装 ​

StateMachine.context

currentState ​

署名を取得する ​

get currentState(): "INITIAL" | "TERMINAL" | States

定義: interface.ts:866

戻り値 ​

"INITIAL" | "TERMINAL" | States

の実装 ​

StateMachine.currentState

possibleStates ​

署名を取得する ​

get possibleStates(): States[]

定義: interface.ts:878

戻り値 ​

States[]

の実装 ​

StateMachine.possibleStates

states ​

署名を取得する ​

get states(): Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

定義: interface.ts:882

戻り値 ​

Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

の実装 ​

StateMachine.states

メソッド ​

happens() ​

コールシグネチャ ​

happens<K>(...args): EventResult<States, K extends keyof EventOutputMapping ? EventOutputMapping[K<K>] : void>

定義: interface.ts:763

型パラメーター ​
K ​

K extends string | number | symbol

パラメータ ​
args ​

...EventArgs<EventPayloadMapping, K>

戻り値 ​

EventResult<States, K extends keyof EventOutputMapping ? EventOutputMapping[K<K>] : void>

の実装 ​

StateMachine.happens

コールシグネチャ ​

happens<K>(...args): EventResult<States, unknown>

定義: interface.ts:769

型パラメーター ​
K ​

K extends string

パラメータ ​
args ​

...EventArgs<EventPayloadMapping, K>

戻り値 ​

EventResult<States, unknown>

の実装 ​

StateMachine.happens

onEventResult() ​

onEventResult(callback): () => void

定義: interface.ts:854

Subscribe to every event result. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

パラメータ ​

callback ​

EventResultCallback<EventPayloadMapping, Context, States>

戻り値 ​

(): void

戻り値 ​

void

の実装 ​

StateMachine.onEventResult

onHappens() ​

onHappens(callback): () => void

定義: interface.ts:836

Subscribe to every happens() call, before the state handles it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

パラメータ ​

callback ​

(args, context) => void

戻り値 ​

(): void

戻り値 ​

void

の実装 ​

StateMachine.onHappens

onStateChange() ​

onStateChange(callback): () => void

定義: interface.ts:826

Subscribe to state changes. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

パラメータ ​

callback ​

StateChangeCallback<States>

戻り値 ​

(): void

戻り値 ​

void

の実装 ​

StateMachine.onStateChange

reset() ​

reset(): void

定義: interface.ts:723

戻り値 ​

void

の実装 ​

StateMachine.reset

setContext() ​

setContext(context): void

定義: interface.ts:870

パラメータ ​

context ​

Context

戻り値 ​

void

の実装 ​

StateMachine.setContext

start() ​

start(): void

定義: interface.ts:729

戻り値 ​

void

の実装 ​

StateMachine.start

switchTo() ​

switchTo(state): void

定義: interface.ts:758

パラメータ ​

state ​

"INITIAL" | "TERMINAL" | States

戻り値 ​

void

の実装 ​

StateMachine.switchTo

wrapup() ​

wrapup(): void

定義: interface.ts:742

戻り値 ​

void

の実装 ​

StateMachine.wrapup