@eveble/eveble

Hierarchy

• Stateful

• Stateful

  ↳ Module

Implemented by

• AgendaCommandSchedulerModule
• App
• BaseApp
• BoundedContext
• Eveble
• Module
• MongoDBCommitStorageModule
• MongoDBSnapshotStorageModule

Index

Properties

• config
• state

Methods

• getSelectableStates
• getState
• hasState
• initialize
• invokeAction
• isInOneOfStates
• isInState
• reset
• setState
• shutdown
• start
• stop
• validateState

Properties

config

• config: Configurable

---

state

• state: State

Inherited from Stateful.state

Overrides void

Methods

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Inherited from Stateful.getSelectableStates

Overrides void

Returns: Record‹string, State›

---

getState

▸ getState(): State

Inherited from Stateful.getState

Overrides void

Returns: State

---

hasState

▸ hasState(): boolean

Inherited from Stateful.hasState

Overrides void

Returns: boolean

---

initialize

▸ initialize(app: BaseApp, injector: Injector): Promise‹void›

Parameters:

Name	Type
app	BaseApp
injector	Injector

Returns: Promise‹void›

▸ initialize(app: BaseApp, injector: Injector): Promise‹void›

Parameters:

Name	Type
app	BaseApp
injector	Injector

Returns: Promise‹void›

---

invokeAction

▸ invokeAction(actionName: string, options: ActionInvokingOptions): Promise‹void›

Parameters:

Name	Type
actionName	string
options	ActionInvokingOptions

Returns: Promise‹void›

▸ invokeAction(actionName: string, options: ActionInvokingOptions): Promise‹void›

Parameters:

Name	Type
actionName	string
options	ActionInvokingOptions

Returns: Promise‹void›

---

isInOneOfStates

▸ isInOneOfStates(states: State | State[]): boolean

Inherited from Stateful.isInOneOfStates

Overrides void

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInState

▸ isInState(state: State | State[]): boolean

Inherited from Stateful.isInState

Overrides void

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

reset

▸ reset(): Promise‹void›

Returns: Promise‹void›

▸ reset(): Promise‹void›

Returns: Promise‹void›

---

setState

▸ setState(state: State): void

Inherited from Stateful.setState

Overrides void

Parameters:

Name	Type
state	State

Returns: void

---

shutdown

▸ shutdown(): Promise‹void›

Returns: Promise‹void›

▸ shutdown(): Promise‹void›

Returns: Promise‹void›

---

start

▸ start(): Promise‹void›

Returns: Promise‹void›

▸ start(): Promise‹void›

Returns: Promise‹void›

---

stop

▸ stop(): Promise‹void›

Returns: Promise‹void›

▸ stop(): Promise‹void›

Returns: Promise‹void›

---

validateState

▸ validateState(stateOrStates: State | State[], error?: Error): boolean

Inherited from Stateful.validateState

Overrides void

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean