Class CliFiberModule

constructor

• new CliFiberModule(container, parentModule): CliFiberModule

• Parameters

  • container: Container
  • parentModule: Module<any>

  Returns CliFiberModule

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<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(_): void

• Parameters

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

  Returns void

exportGlobal

• exportGlobal(_): void

• Parameters

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

  Returns void

getAliasesPointingTo

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

• Parameters

  • key: TBindKey<any>

  Returns TBindKey<any>[]

getAsyncFactory

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

• 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

getModuleConfig

• getModuleConfig<Cfg>(): undefined | Cfg

• Type Parameters

  • Cfg = any

  Returns undefined | Cfg

getOwnAlias

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

• Parameters

  • key: TBindKey<any>

  Returns undefined | TBindKey<any>

getParentModule

• getParentModule(): Module<any>

• Returns Module<any>

getSyncFactory

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

• Type Parameters

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

  Parameters

  • key: TBindKey<any>

  Returns [F, Module<any>]

hasExportedAsyncBinding

• hasExportedAsyncBinding(_): boolean

• Parameters

  • _: TBindKey<any>

  Returns boolean

hasExportedSyncBinding

• hasExportedSyncBinding(_): boolean

• Parameters

  • _: 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>

• Parameters

  • modules: TClassConstructor<Module<any>, any[]> | TConfiguredModuleTerm<Module<any>, Container, CliFiberModule, any> | (TClassConstructor<Module<any>, any[]> | TConfiguredModuleTerm<Module<any>, Container, CliFiberModule, 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

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>