MongoDBSnapshotStorageModule

Type parameters

T: SuperConstructor

T: SuperConstructor

Hierarchy

Module

  • Module

    MongoDBSnapshotStorageModule

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

+ new MongoDBSnapshotStorageModule(props?: ModuleProps): MongoDBSnapshotStorageModule

Inherited from Module.constructor

Overrides void

Parameters:

NameType
props?ModuleProps

Returns: MongoDBSnapshotStorageModule

Properties

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:

NameType
appBaseApp
injectorInjector

Returns: Promise‹void›


invokeAction

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

Implementation of Module

Inherited from Module.invokeAction

Overrides void

Parameters:

NameType
actionNamestring
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:

NameType
statesState | 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:

NameType
stateState | 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:

NameType
stateState

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:

NameType
stateOrStatesState | State[]
error?Error

Returns: boolean