Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleStore

ModuleStore unites all module store connectors into one API, so consumer have same way how to get internal or external module

Note: Modules storage - is just getter / setter for modules Modules store - has full logic of modules domain

collboard-system

Hierarchy

  • AbstractSystem
    • ModuleStore

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ModuleStore(systems: ISystemsExtended): ModuleStore

  • Parameters

    • systems: ISystemsExtended

    Returns ModuleStore

Properties

Readonly connectors

connectors: IModuleStoreConnector[]

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Protected Readonly systems

systems: ISystemsExtended

Accessors

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): ModuleStore

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns ModuleStore

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Destroy the object

    Returns Promise<void>

getCategories

  • getCategories(): Promise<Set<string>>

getModule

init

  • init(): Promise<void>

  • Returns Promise<void>

registerModuleStorage

  • registerModuleStorage(modulesStorage: IModulesStorageStrong): Registration

  • Note: When searching with limit, it depends on order of connectors registration

    Parameters

    • modulesStorage: IModulesStorageStrong

    Returns Registration

registerModuleStoreConnector

  • Note: When searching with limit, it depends on order of connectors registration

    Parameters

    Returns Registration

search

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable