Class Module<Cfg>

constructor

• new Module<Cfg>(container, config?): Module<Cfg>

• Type Parameters

  • Cfg = any

  Parameters

  • container: Container
  • Optional config: Cfg

  Returns Module<Cfg>

Static Readonly __svt_module_traits

bind

• get bind(): BindManager<this>

• Returns bind manager (aka bind util)

  Returns BindManager<this>

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
  • aliasKey: TBindKey

  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
  • 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
  • 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 | TBindKey[]

  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 | TBindKey[]

  Returns void

getAliasesPointingTo

• getAliasesPointingTo(key): TBindKey[]

• Returns all aliases pointing to the binding key

  Parameters

  • key: TBindKey

  Returns TBindKey[]

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

  Returns [F, Module<any>]

getContainer

• getContainer(): Container

• Returns container

  Returns Container

getModuleConfig

• getModuleConfig(): undefined | Cfg

• Returns undefined | Cfg

getOwnAlias

• getOwnAlias(key): undefined | TBindKey

• Parameters

  • key: TBindKey

  Returns undefined | TBindKey

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

  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

  Returns boolean

hasExportedSyncBinding

• hasExportedSyncBinding(key): boolean

• Returns true if binding is exported from this module.

  Parameters

  • key: TBindKey

  Returns boolean

hasImportedAsyncBinding

• hasImportedAsyncBinding(key): boolean

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

  Parameters

  • key: TBindKey

  Returns boolean

  See

  Module.import

hasImportedSyncBinding

• hasImportedSyncBinding(key): boolean

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

  Parameters

  • key: TBindKey

  Returns boolean

hasOwnAlias

• hasOwnAlias(key): boolean

• Parameters

  • key: TBindKey

  Returns boolean

hasOwnAsyncBind

• hasOwnAsyncBind(key): boolean

• Parameters

  • key: TBindKey

  Returns boolean

hasOwnBind

• hasOwnBind(key): boolean

• Parameters

  • key: TBindKey

  Returns boolean

hasOwnBindOrAlias

• hasOwnBindOrAlias(key): boolean

• Parameters

  • key: TBindKey

  Returns boolean

hasOwnSyncBind

• hasOwnSyncBind(key): boolean

• Parameters

  • key: TBindKey

  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>> | TConfiguredModuleTerm<Module<any>, Container, Module<Cfg>, any> | (TClassConstructor<Module<any>> | TConfiguredModuleTerm<Module<any>, Container, Module<Cfg>, 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>
  • 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
  • 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>
  • 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
  • Optional options: null | Partial<IInjectOptions>
  • Optional ctx: TProvideContext

  Returns T

setup

• setup(): Promise<void>

• This method invokes user defined bindings, imports, export and internal module related init logic. Any entity initialization logic should be placed in corresponded factory to minimize module initialization time.

  Returns Promise<void>