AgendaCommandSchedulerModule

Type parameters

▪ T: SuperConstructor

▪ T: SuperConstructor

Hierarchy

↳ Module

• Module

  ↳ AgendaCommandSchedulerModule

Implements

• Stateful
• Stateful
• Module
• Stateful
• Stateful
• Module

Index

Constructors

• constructor

Properties

• agendaClient
• app
• config
• injector
• log
• modules
• mongoClient
• state
• STATES

Methods

• getSelectableStates
• getState
• hasState
• initialize
• initializeAgendaClientForCommandScheduler
• initializeCommandScheduler
• initializeMongoDBClientForCommandScheduler
• initializeTopLevelDependencies
• invokeAction
• isInDevelopment
• isInOneOfStates
• isInProduction
• isInState
• reset
• setState
• shutdown
• start
• stop
• validateState

Constructors

constructor

+ new AgendaCommandSchedulerModule(props?: ModuleProps): AgendaCommandSchedulerModule

Inherited from Module.constructor

Overrides void

Parameters:

Name	Type
props?	ModuleProps

Returns: AgendaCommandSchedulerModule

Properties

Optional agendaClient

• agendaClient? : AgendaClient

---

Optional app

• app? : BaseApp

Inherited from Module.app

Overrides void

---

config

• config: Configurable

Implementation of Module.config

Inherited from Module.config

Overrides void

---

injector

• injector: Injector

Inherited from Module.injector

Overrides void

---

Optional log

• log? : Logger

Inherited from Module.log

Overrides void

---

modules

• modules: Module[]

Inherited from Module.modules

Overrides void

---

Optional mongoClient

• mongoClient? : MongoDBClient

---

state

• state: State

Implementation of Module.state

Inherited from StatefulMixin.state

Overrides void

---

Static STATES

▪ STATES: typeof STATES

Inherited from Module.STATES

Overrides void

Methods

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Implementation of Module

Inherited from StatefulMixin.getSelectableStates

Overrides Task.getSelectableStates

Returns: Record‹string, State›

---

getState

▸ getState(): State

Implementation of Module

Inherited from StatefulMixin.getState

Overrides Task.getState

Returns: State

---

hasState

▸ hasState(): boolean

Implementation of Module

Inherited from StatefulMixin.hasState

Overrides Task.hasState

Returns: boolean

---

initialize

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

Implementation of Module

Inherited from Module.initialize

Overrides void

Parameters:

Name	Type
app	BaseApp
injector	Injector

Returns: Promise‹void›

---

initializeAgendaClientForCommandScheduler

▸ initializeAgendaClientForCommandScheduler(): Promise‹void›

Initializes Agenda client for CommandScheduler.

async

Returns: Promise‹void›

---

initializeCommandScheduler

▸ initializeCommandScheduler(): Promise‹void›

Initializes CommandScheduler.

async

Returns: Promise‹void›

---

initializeMongoDBClientForCommandScheduler

▸ initializeMongoDBClientForCommandScheduler(): Promise‹void›

Initializes MongoDB client for CommandScheduler.

async

Returns: Promise‹void›

---

initializeTopLevelDependencies

▸ initializeTopLevelDependencies(): Promise‹void›

Initializes top level dependencies.

async

Returns: Promise‹void›

---

invokeAction

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

Implementation of Module

Inherited from Module.invokeAction

Overrides void

Parameters:

Name	Type
actionName	string
options?	ActionInvokingOptions

Returns: Promise‹void›

---

isInDevelopment

▸ isInDevelopment(): boolean

Inherited from Module.isInDevelopment

Overrides void

Returns: boolean

---

isInOneOfStates

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

Implementation of Module

Inherited from StatefulMixin.isInOneOfStates

Overrides Task.isInOneOfStates

Parameters:

Name	Type
states	State | State[]

Returns: boolean

---

isInProduction

▸ isInProduction(): boolean

Inherited from Module.isInProduction

Overrides void

Returns: boolean

---

isInState

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

Implementation of Module

Inherited from StatefulMixin.isInState

Overrides Task.isInState

Parameters:

Name	Type
state	State | State[]

Returns: boolean

---

reset

▸ reset(): Promise‹void›

Implementation of Module

Inherited from Module.reset

Overrides void

Returns: Promise‹void›

---

setState

▸ setState(state: State): void

Implementation of Module

Inherited from StatefulMixin.setState

Overrides Task.setState

Parameters:

Name	Type
state	State

Returns: void

---

shutdown

▸ shutdown(): Promise‹void›

Implementation of Module

Inherited from Module.shutdown

Overrides void

Returns: Promise‹void›

---

start

▸ start(): Promise‹void›

Implementation of Module

Inherited from Module.start

Overrides void

Returns: Promise‹void›

---

stop

▸ stop(): Promise‹void›

Implementation of Module

Inherited from Module.stop

Overrides void

Returns: Promise‹void›

---

validateState

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

Implementation of Module

Inherited from StatefulMixin.validateState

Overrides Task.validateState

Parameters:

Name	Type
stateOrStates	State | State[]
error?	Error

Returns: boolean