Class CliModule

Hierarchy

Constructors

constructor

Properties

aliases bindManger config? container exports factoriesAsync factoriesSync importedDynamicModules importer imports initialized __svt_module_traits

Accessors

bind

Methods

alias bindAsync bindSync export exportGlobal getAliasesPointingTo getAsyncFactory getContainer getImporter getModuleConfig getOwnAlias getSourceModuleInstances getSyncFactory hasExportedAsyncBinding hasExportedSyncBinding hasImportedAsyncBinding hasImportedSyncBinding hasOwnAlias hasOwnAsyncBind hasOwnBind hasOwnBindOrAlias hasOwnSyncBind import init provideAsync provideSync setImporter setup setupDefaultBindings configured

Constructors

constructor

  • new CliModule(container, config?): CliModule

  • Parameters

    Returns CliModule

Properties

Protected Readonly aliases

aliases: Map<TBindKey<any>, TBindKey<any>>

Protected Readonly bindManger

bindManger: BindManager<CliModule>

Protected Optional Readonly config

config?: ICliModuleConfig

Protected container

container: Container

Protected Readonly exports

exports: Set<TBindKey<any>>

Protected Readonly factoriesAsync

factoriesAsync: Map<TBindKey<any>, IAsyncFactory<any, Module<any>>>

Protected Readonly factoriesSync

factoriesSync: Map<TBindKey<any>, ISyncFactory<any, Module<any>>>

Protected Readonly importedDynamicModules

importedDynamicModules: Set<Module<any>>

Protected importer

importer: Container | Module<any>

Protected Readonly imports

imports: Set<TClassConstructor<Module<any>, any[]>>

Protected initialized

initialized: boolean

Static Readonly __svt_module_traits

__svt_module_traits: string[]

Accessors

bind

  • get bind(): BindManager<this>

  • Returns bind manager (aka bind util)

    Returns BindManager<this>

Methods

alias

  • alias(key, aliasKey): void

  • Defines an alias (aka link) to another binding. Alias can be used in export and global export to achieve global "scoped" bindings for dynamic modules. (see @silvertree/logging for usage example)

    Parameters

    • key: TBindKey<any>
    • aliasKey: TBindKey<any>

    Returns void

bindAsync

  • bindAsync<F>(key, factory): FactoryBindContext<Module<any>, any, F>

  • Binds async factory to key

    Type Parameters

    • F extends IAsyncFactory<any, Module<any>>

    Parameters

    • key: TBindKey<any>
    • factory: F

    Returns FactoryBindContext<Module<any>, any, F>

bindSync

  • bindSync<F>(key, factory): FactoryBindContext<Module<any>, any, F>

  • Binds sync factory to key

    Type Parameters

    • F extends ISyncFactory<any, Module<any>>

    Parameters

    • key: TBindKey<any>
    • factory: F

    Returns FactoryBindContext<Module<any>, any, F>

export

  • export(keys): void

  • Defines binding or reference to binding export from this module

    Parameters

    • keys: TBindKey<any> | TBindKey<any>[]

    Returns void

exportGlobal

  • exportGlobal(keys): void

  • Defines binding or reference to binding global export from this module. This binding will be available in all modules and by calling provide* methods in container.

    Parameters

    • keys: TBindKey<any> | TBindKey<any>[]

    Returns void

getAliasesPointingTo

  • getAliasesPointingTo(key): TBindKey<any>[]

  • Returns all aliases pointing to the binding key

    Parameters

    • key: TBindKey<any>

    Returns TBindKey<any>[]

getAsyncFactory

  • getAsyncFactory<T, F>(key): [F, Module<any>]

  • Returns async entity factory by given key. It will try to find factory from the current module, then from imported modules and finally from global exports. It will also try to resolve sync binding if async binding is not found.

    Type Parameters

    • T = any
    • F extends IAsyncFactory<T, Module<any>> = IAsyncFactory<T, Module<any>>

    Parameters

    • key: TBindKey<any>

    Returns [F, Module<any>]

getContainer

  • getContainer(): Container

  • Returns container

    Returns Container

getImporter

  • getImporter(): Container | Module<any>

  • Returns module which imports this dynamic module

    Returns Container | Module<any>

getModuleConfig

  • getModuleConfig(): undefined | ICliModuleConfig

  • Returns undefined | ICliModuleConfig

getOwnAlias

  • getOwnAlias(key): undefined | TBindKey<any>

  • Parameters

    • key: TBindKey<any>

    Returns undefined | TBindKey<any>

Protected getSourceModuleInstances

  • getSourceModuleInstances(): Generator<Container | Module<any>, void, undefined>

  • Returns module instances which can be used for resolving bindings in this module

    Returns Generator<Container | Module<any>, void, undefined>

getSyncFactory

  • getSyncFactory<T, F>(key): [F, Module<any>]

  • Returns sync entity factory by given key. It will try to find factory from the current module, then from imported modules and finally from global exports.

    Type Parameters

    • T = any
    • F extends ISyncFactory<T, Module<any>> = ISyncFactory<T, Module<any>>

    Parameters

    • key: TBindKey<any>

    Returns [F, Module<any>]

hasExportedAsyncBinding

  • hasExportedAsyncBinding(key): boolean

  • Returns true if binding is exported from this module. Also includes sync imports check.

    Parameters

    • key: TBindKey<any>

    Returns boolean

hasExportedSyncBinding

  • hasExportedSyncBinding(key): boolean

  • Returns true if binding is exported from this module.

    Parameters

    • key: TBindKey<any>

    Returns boolean

hasImportedAsyncBinding

  • hasImportedAsyncBinding(key): boolean

  • Returns true if async (or sync) binding is imported from other modules.

    Parameters

    • key: TBindKey<any>

    Returns boolean

    See

    Module.import

hasImportedSyncBinding

  • hasImportedSyncBinding(key): boolean

  • Returns true if sync binding is imported from other modules.

    Parameters

    • key: TBindKey<any>

    Returns boolean

hasOwnAlias

  • hasOwnAlias(key): boolean

  • Parameters

    • key: TBindKey<any>

    Returns boolean

hasOwnAsyncBind

  • hasOwnAsyncBind(key): boolean

  • Parameters

    • key: TBindKey<any>

    Returns boolean

hasOwnBind

  • hasOwnBind(key): boolean

  • Parameters

    • key: TBindKey<any>

    Returns boolean

hasOwnBindOrAlias

  • hasOwnBindOrAlias(key): boolean

  • Parameters

    • key: TBindKey<any>

    Returns boolean

hasOwnSyncBind

  • hasOwnSyncBind(key): boolean

  • Parameters

    • key: TBindKey<any>

    Returns boolean

import

  • import(modules): Promise<void>

  • Imports modules into current the current module. All exported bindings (and/or its aliases) will be available in the current module.

    Parameters

    • modules: TClassConstructor<Module<any>, any[]> | TConfiguredModuleTerm<Module<any>, Container, CliModule, any> | (TClassConstructor<Module<any>, any[]> | TConfiguredModuleTerm<Module<any>, Container, CliModule, any>)[]

    Returns Promise<void>

init

  • init(): Promise<unknown>

  • Initializes module

    Returns Promise<unknown>

provideAsync

  • provideAsync<T>(key, options?, ctx?): Promise<T>

  • Returns resolved entity by given async binding or binding ref. It will try to find binding from the current module, then from imported modules and finally from global exports. It will also try to resolve sync binding if async binding is not found.

    Type Parameters

    • T

    Parameters

    • key: TClassConstructor<T, any[]>
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns Promise<T>

  • provideAsync<T>(key, options?, ctx?): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • key: string | symbol
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns Promise<T>

  • provideAsync<T>(key, options?, ctx?): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • key: TBindKey<any>
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns Promise<T>

provideSync

  • provideSync<T>(key, options?, ctx?): T

  • Returns resolved entity by given sync binding or binding ref. It will try to find binding from the current module, then from imported modules and finally from global exports.

    Type Parameters

    • T

    Parameters

    • key: TClassConstructor<T, any[]>
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns T

  • provideSync<T>(key, options?, ctx?): T

  • Type Parameters

    • T = any

    Parameters

    • key: string | symbol
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns T

  • provideSync<T>(key, options?, ctx?): T

  • Type Parameters

    • T = any

    Parameters

    • key: TBindKey<any>
    • Optional options: null | Partial<IInjectOptions>
    • Optional ctx: TProvideContext

    Returns T

setImporter

  • setImporter(importer): void

  • Internal method which is called by container or module which imports this dynamic module. Sets module which imports this dynamic module.

    Parameters

    • importer: Container | Module<any>

    Returns void

setup

Protected setupDefaultBindings

  • setupDefaultBindings(): Promise<void>

  • Defines basic bindings such as module config, container, etc.

    Returns Promise<void>

Static configured

Settings

Member Visibility

Theme

On This Page

constructoraliasesbindMangerconfigcontainerexportsfactoriesAsyncfactoriesSyncimportedDynamicModulesimporterimportsinitialized__svt_module_traitsbindaliasbindAsyncbindSyncexportexportGlobalgetAliasesPointingTogetAsyncFactorygetContainergetImportergetModuleConfiggetOwnAliasgetSourceModuleInstancesgetSyncFactoryhasExportedAsyncBindinghasExportedSyncBindinghasImportedAsyncBindinghasImportedSyncBindinghasOwnAliashasOwnAsyncBindhasOwnBindhasOwnBindOrAliashasOwnSyncBindimportinitprovideAsyncprovideSyncsetImportersetupsetupDefaultBindingsconfigured