@jewel998/state-machine - v0.0.5 / StateMachineDefinitionBuilder

Class: StateMachineDefinitionBuilder<TContext, TState, TEvent>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier
TEvent	extends EventIdentifier

Implements

• IStateMachineDefinitionBuilder<TContext, TState, TEvent>

Table of contents

Constructors

• constructor

Methods

• initialState
• state
• transition
• guard
• action
• transaction
• onStateEntry
• onStateExit
• addMiddleware
• buildDefinition

Constructors

constructor

• new StateMachineDefinitionBuilder<TContext, TState, TEvent>(): StateMachineDefinitionBuilder<TContext, TState, TEvent>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier
TEvent	extends EventIdentifier

Returns

StateMachineDefinitionBuilder<TContext, TState, TEvent>

Methods

initialState

▸ initialState(state): this

Parameters

Name	Type
state	TState

Returns

this

Implementation of

IStateMachineDefinitionBuilder.initialState

Defined in

src/core/StateMachineDefinitionBuilder.ts:43

---

state

▸ state(state): this

Parameters

Name	Type
state	TState

Returns

this

Implementation of

IStateMachineDefinitionBuilder.state

Defined in

src/core/StateMachineDefinitionBuilder.ts:50

---

transition

▸ transition(from, to, event): this

Parameters

Name	Type
from	TState
to	TState
event	TEvent

Returns

this

Implementation of

IStateMachineDefinitionBuilder.transition

Defined in

src/core/StateMachineDefinitionBuilder.ts:56

---

guard

▸ guard(condition): this

Parameters

Name	Type
condition	GuardFunction<TContext>

Returns

this

Implementation of

IStateMachineDefinitionBuilder.guard

Defined in

src/core/StateMachineDefinitionBuilder.ts:77

---

action

▸ action(callback): this

Parameters

Name	Type
callback	ActionFunction<TContext>

Returns

this

Implementation of

IStateMachineDefinitionBuilder.action

Defined in

src/core/StateMachineDefinitionBuilder.ts:100

---

transaction

▸ transaction(callback, rollback?): this

Parameters

Name	Type
callback	TransactionFunction<TContext>
rollback?	RollbackFunction<TContext>

Returns

this

Implementation of

IStateMachineDefinitionBuilder.transaction

Defined in

src/core/StateMachineDefinitionBuilder.ts:123

---

onStateEntry

▸ onStateEntry(state, callback): this

Parameters

Name	Type
state	TState
callback	ActionFunction<TContext>

Returns

this

Implementation of

IStateMachineDefinitionBuilder.onStateEntry

Defined in

src/core/StateMachineDefinitionBuilder.ts:151

---

onStateExit

▸ onStateExit(state, callback): this

Parameters

Name	Type
state	TState
callback	ActionFunction<TContext>

Returns

this

Implementation of

IStateMachineDefinitionBuilder.onStateExit

Defined in

src/core/StateMachineDefinitionBuilder.ts:162

---

addMiddleware

▸ addMiddleware(middleware): this

Parameters

Name	Type
middleware	MiddlewareConfig<TContext, TState>

Returns

this

Defined in

src/core/StateMachineDefinitionBuilder.ts:173

---

buildDefinition

▸ buildDefinition(): IStateMachineDefinition<TContext, TState, TEvent>

Returns

IStateMachineDefinition<TContext, TState, TEvent>

Implementation of

IStateMachineDefinitionBuilder.buildDefinition

Defined in

src/core/StateMachineDefinitionBuilder.ts:179