@eveble/eveble

Hierarchy

• Stateful

  ↳ Logger

  ↳ BaseApp

  ↳ Module

  ↳ Entity

  ↳ CommitReceiver

  ↳ Client

  ↳ CommandScheduler

  ↳ ScheduledJob

Implemented by

• AgendaClient
• AgendaCommandScheduler
• AgendaCommandSchedulerModule
• AgendaCommandSchedulerModule
• Aggregate
• App
• App
• BaseApp
• BaseApp
• BoundedContext
• BoundedContext
• Client
• CommitMongoDBObserver
• CommitReceiver
• Entity
• Eveble
• Eveble
• EventSourceable
• Logger
• Module
• Module
• MongoDBClient
• MongoDBCommitStorageModule
• MongoDBCommitStorageModule
• MongoDBSnapshotStorageModule
• MongoDBSnapshotStorageModule
• Process
• Projection
• ScheduledJob
• StatefulMixin

Index

Properties

• state

Methods

• getSelectableStates
• getState
• hasState
• isInOneOfStates
• isInState
• setState
• validateState

Properties

state

• state: State

Methods

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Returns: Record‹string, State›

▸ getSelectableStates(): Record‹string, State›

Returns: Record‹string, State›

---

getState

▸ getState(): State

Returns: State

▸ getState(): State

Returns: State

---

hasState

▸ hasState(): boolean

Returns: boolean

▸ hasState(): boolean

Returns: boolean

---

isInOneOfStates

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

Parameters:

Name	Type
states	State | State[]

Returns: boolean

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

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInState

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

Parameters:

Name	Type
state	State | State[]

Returns: boolean

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

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

setState

▸ setState(state: State): void

Parameters:

Name	Type
state	State

Returns: void

▸ setState(state: State): void

Parameters:

Name	Type
state	State

Returns: void

---

validateState

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

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean

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

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean