Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttributeSupportSyncer

AttributeSupportSyncer installs / uninstalls ONLY STANDARD attribute modules when needed

collboard-system

Hierarchy

  • AbstractSyncer
    • AttributeSupportSyncer

Implements

  • ISyncer
  • IDestroyable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns AttributeSupportSyncer

Properties

Private attributeDependencies

attributeDependencies: any

Protected modulesStorage

modulesStorage: Promisable<IModulesStorageWeak>

Readonly ready

ready: Promise<void>

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

Protected Readonly systems

systems: ISystemsExtended

Private throttleQueues

throttleQueues: any

Accessors

firstSynchronization

  • get firstSynchronization(): Promise<void>

  • Promise that resolves when the first synchronization is done

    Returns Promise<void>

installations

  • get installations(): ModuleInstallation[]

  • Returns ModuleInstallation[]

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

statusOf

  • get statusOf(): (moduleManifest: IModuleManifest) => BehaviorSubject<ModuleStatus>

  • Returns (moduleManifest: IModuleManifest) => BehaviorSubject<ModuleStatus>

Methods

addSubdestroyable

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

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns AttributeSupportSyncer

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>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

Protected initSyncer

  • initSyncer(): void | Promise<void>

  • Returns void | Promise<void>

install

  • install(dependency: IDependency, syncerName?: string): Promise<void>

  • Parameters

    • dependency: IDependency
    • Optional syncerName: string

    Returns Promise<void>

installSupportForAttribute

  • installSupportForAttribute(attributeName: string): Promise<unknown>

  • Parameters

    • attributeName: string

    Returns Promise<unknown>

sync

  • sync(dependenciesTarget: IDependenciesRecord): Promise<void>

  • TODO: !! Probbably do not use confusing shortcut sync but synchronize

    Parameters

    • dependenciesTarget: IDependenciesRecord

    Returns Promise<void>

uninstall

  • uninstall(dependency: IDependency): Promise<void>

  • Parameters

    • dependency: IDependency

    Returns Promise<void>

uninstallAll

  • uninstallAll(): Promise<void>

  • Returns Promise<void>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable