Class Container

Container is a root object of the DI system.

Constructors

constructor

new Container(): Container
Returns Container

Properties

`Protected` `Readonly` dynamicModules

dynamicModules: Set<Module<any>> = ...

`Protected` `Readonly` globalFactoryRefs

globalFactoryRefs: Map<Module<any>, Set<TBindKey>> = ...

`Protected` `Readonly` globalRefWaiters

globalRefWaiters: Map<TBindKey, Set<(() => unknown)>> = ...

`Protected` `Readonly` modules

modules: Set<Module<any>> = ...

Methods

getAsyncModuleFactory

getAsyncModuleFactory<T, M, F>(key): [F, M]
Returns an async factory by its key from already bound as global bindings.
Type Parameters
- T = any
- M extends Module<any> = Module<any>
- F extends IAsyncFactory<T, M> = IAsyncFactory<T, M>
Parameters
- key: TBindKey
Returns [F, M]
- Defined in packages/core/src/container/Container.ts:212

getDynamicModules

getDynamicModules(): Set<Module<any>>
Returns dynamic modules, registered directly in the container.

Returns Set<Module<any>>
- Defined in packages/core/src/container/Container.ts:99

getDynamicModulesByClass

getDynamicModulesByClass<M>(module): M[]
Returns dynamic modules, registered directly in the container by class.
Type Parameters
- M extends Module<any>
Parameters
- module: TClassConstructor<M>
Returns M[]
- Defined in packages/core/src/container/Container.ts:138

getModule

getModule<M>(module): M
Returns a module by its class.
Type Parameters
- M extends Module<any>
Parameters
- module: TClassConstructor<M>
Returns M
- Defined in packages/core/src/container/Container.ts:124

getModules

getModules(): Set<Module<any>>
Returns all registered modules.

Returns Set<Module<any>>
- Defined in packages/core/src/container/Container.ts:92

getSyncModuleFactory

getSyncModuleFactory<T, M, F>(key): [F, M]
Returns a sync factory by its key from already bound as global bindings.
Type Parameters
- T = any
- M extends Module<any> = Module<any>
- F extends ISyncFactory<T, M> = ISyncFactory<T, M>
Parameters
- key: TBindKey
Returns [F, M]
- Defined in packages/core/src/container/Container.ts:187

hasAsyncBinding

hasAsyncBinding(key): boolean
Determines if an async binding exists in global exports.
Parameters
- key: TBindKey
Returns boolean
- Defined in packages/core/src/container/Container.ts:253

hasModule

hasModule(module): boolean
Returns true if module is registered in the container.
Parameters
- module: Module<any> | TClassConstructor<Module<any>>
Returns boolean
- Defined in packages/core/src/container/Container.ts:106

hasSyncBinding

hasSyncBinding(key): boolean
Determines if a sync binding exists in global exports.
Parameters
- key: TBindKey
Returns boolean
- Defined in packages/core/src/container/Container.ts:237

`Protected` initModule

initModule(module): Promise<void>
Protected
Internal method for initializing a module.
Parameters
- module: Module<any>
Returns Promise<void>
- Defined in packages/core/src/container/Container.ts:155

provideAsync

provideAsync<T>(key, options?, ctx?): Promise<T>
Provides a value of a binding by its key.
Type Parameters
- T
Parameters
- key: TClassConstructor<T>
- Optional options: null | Partial<IInjectOptions>
- Optional ctx: TProvideContext
Returns Promise<T>
- Defined in packages/core/src/container/Container.ts:290
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>
- Defined in packages/core/src/container/Container.ts:291
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>
- Defined in packages/core/src/container/Container.ts:292

provideSync

provideSync<T>(key, options?, ctx?): T
Provides a value of a binding by its key.
Type Parameters
- T
Parameters
- key: TClassConstructor<T>
- Optional options: null | Partial<IInjectOptions>
- Optional ctx: TProvideContext
Returns T
- Defined in packages/core/src/container/Container.ts:272
provideSync<T>(key, options?, ctx?): T
Type Parameters
- T = any
Parameters
- key: string | symbol
- Optional options: null | Partial<IInjectOptions>
- Optional ctx: TProvideContext
Returns T
- Defined in packages/core/src/container/Container.ts:273
provideSync<T>(key, options?, ctx?): T
Type Parameters
- T = any
Parameters
- key: TBindKey
- Optional options: null | Partial<IInjectOptions>
- Optional ctx: TProvideContext
Returns T
- Defined in packages/core/src/container/Container.ts:274

register

register<M, Cfg>(module, configure?, options?): Promise<M>
Registers a new module in the container.
Type Parameters
- M extends Module<any>
- Cfg = M extends Module<C>
  ? C
  : any
Parameters
- module: TClassConstructor<M>
- Optional configure: null | ((container, module) => Cfg | Promise<Cfg>)
- Optional options: {
  skipInitPhase?: boolean;
  }
  - Optional skipInitPhase?: boolean
Returns Promise<M>
- Defined in packages/core/src/container/Container.ts:35

registerBatch

registerBatch(modules): Promise<Container>
Registers a batch of modules in the container.
Parameters
- modules: (TClassConstructor<Module<any>> | TConfiguredModuleTerm<Module<any>, Container, null, any>)[]
Returns Promise<Container>
- Defined in packages/core/src/container/Container.ts:75

registerGlobalBindingRef

registerGlobalBindingRef(module, key): void
Registers a sync factory with a key as a global exported binding. Module also should export this key.
Parameters
- module: Module<any>
- key: TBindKey | TBindKeyRef
Returns void
- Defined in packages/core/src/container/Container.ts:164

waitFowGlobalBinding

waitFowGlobalBinding(key): Promise<void>
Returns a promise which will be resolved when all global bindings are available.
Parameters
- key: TBindKey | TBindKeyRef | (TBindKey | TBindKeyRef)[]
Returns Promise<void>
- Defined in packages/core/src/container/Container.ts:305

`Static` make

make(): Container
Creates a new container. Just a nice shortcut for new Container().

Returns Container
- Defined in packages/core/src/container/Container.ts:28

Class Container

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Container

Properties

Protected Readonly dynamicModules

Protected Readonly globalFactoryRefs

Protected Readonly globalRefWaiters

Protected Readonly modules

Methods

getAsyncModuleFactory

Type Parameters

Parameters

Returns [F, M]

getDynamicModules

Returns Set<Module<any>>

getDynamicModulesByClass

Type Parameters

Parameters

Returns M[]

getModule

Type Parameters

Parameters

Returns M

getModules

Returns Set<Module<any>>

getSyncModuleFactory

Type Parameters

Parameters

Returns [F, M]

hasAsyncBinding

Parameters

Returns boolean

hasModule

Parameters

Returns boolean

hasSyncBinding

Parameters

Returns boolean

Protected initModule

Parameters

Returns Promise<void>

provideAsync

Type Parameters

Parameters

Returns Promise<T>

Type Parameters

Parameters

Returns Promise<T>

Type Parameters

Parameters

Returns Promise<T>

provideSync

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

register

Type Parameters

Parameters

Optional skipInitPhase?: boolean

Returns Promise<M>

registerBatch

Parameters

Returns Promise<Container>

registerGlobalBindingRef

Parameters

Returns void

waitFowGlobalBinding

Parameters

Returns Promise<void>

`Protected` `Readonly` dynamicModules

`Protected` `Readonly` globalFactoryRefs

`Protected` `Readonly` globalRefWaiters

`Protected` `Readonly` modules

`Protected` initModule

`Optional` skipInitPhase?: boolean

`Static` make