Class: ObjectContainer
Defined in: packages/core/src/oc/ObjectContainer.ts:61
The Object Container is an enhanced dependency injector with support for aliases and constants, and allowing to reference classes in the application namespace by specifying their fully qualified names.
Constructors
new ObjectContainer()
new ObjectContainer(
namespace):ObjectContainer
Defined in: packages/core/src/oc/ObjectContainer.ts:91
Initializes the object container.
Parameters
namespace
The namespace container, used to access classes and values using their fully qualified names.
Returns
Methods
_createEntry()
_createEntry<
T>(classConstructor,dependencies?,options?):Entry<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:648
Creates a new entry for the provided class or factory function, the provided dependencies and entry options.
Type Parameters
• T
Parameters
classConstructor
EntryConstructor<T>
The class constructor or factory function.
dependencies?
any[]
The dependencies to pass into the constructor or factory function.
options?
Returns
Entry<T>
Created instance or generated value.
_createInstanceFromEntry()
_createInstanceFromEntry<
T,E>(entry,dependencies):T
Defined in: packages/core/src/oc/ObjectContainer.ts:687
Creates a new instance of the class or retrieves the value generated by the factory function represented by the provided entry, passing in the provided dependencies.
The method uses the dependencies specified by the entry if no custom dependencies are provided.
Type Parameters
• T
• E extends Entry<T>
Parameters
entry
E
The entry representing the class that should have its instance created or factory faction to use to create a value.
dependencies
any[] = []
The dependencies to pass into the constructor or factory function.
Returns
T
Created instance or generated value.
_getEntry()
_getEntry<
T>(name):null|Entry<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:536
Retrieves the entry for the specified constant, alias, class or factory function, interface, or fully qualified namespace path (the method checks these in this order in case of a name clash).
The method retrieves an existing entry even if a qualified namespace path is provided (if the target class or interface has been configured in this object container).
The method throws an Error if no such constant, alias, registry, interface implementation is known to this object container and the provided identifier is not a valid namespace path specifying an existing class, interface or value.
Type Parameters
• T
Parameters
name
Dependency<T>
Name of a constant or alias, factory function, class or interface constructor, or a fully qualified namespace path.
Returns
null | Entry<T>
The retrieved entry.
Throws
If no such constant, alias, registry, interface implementation is known to this object container.
_getEntryFromClassConstructor()
_getEntryFromClassConstructor<
T>(classConstructor):null|Entry<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:842
Retrieves the class denoted by the provided class constructor.
The method then checks whether there are defined $dependencies
property for class. Then the class is registered to this object
container.
The method returns the entry for the class if the specified class
does not have defined $dependencies property return
null.
Type Parameters
• T
Parameters
classConstructor
OCInjectable<T>
Returns
null | Entry<T>
An entry representing the value at the specified
classConstructor. The method returns null
if the specified classConstructor does not have defined
$dependencies.
_getEntryFromConstant()
_getEntryFromConstant<
T>(compositionName):null|Entry<() =>T>
Defined in: packages/core/src/oc/ObjectContainer.ts:748
Retrieves the constant value denoted by the provided fully qualified composition name.
The method returns the entry for the constant if the constant is registered
with this object container, otherwise return null.
Finally, if the constant composition name does not resolve to value,
the method return null.
Type Parameters
• T
Parameters
compositionName
string
Returns
null | Entry<() => T>
An entry representing the value at the specified
composition name in the constants. The method returns null
if the specified composition name does not exist in the constants.
_getEntryFromNamespace()
_getEntryFromNamespace<
T>(path):null|Entry<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:804
Retrieves the class denoted by the provided fully qualified name within the application namespace.
The method then checks whether there are dependencies configured for the class, no matter whether the class is an implementation class or an "interface" class.
The method returns the entry for the class if the class is registered with this object container, otherwise an unregistered entry is created and returned.
Finally, if the namespace path does not resolve to a class, the method return an unregistered entry resolved to the value denoted by the namespace path.
Alternatively, if a constructor function is passed in instead of a
namespace path, the method returns null.
Type Parameters
• T
Parameters
path
string
Namespace path pointing to a class or a value in the application namespace, or a constructor function.
Returns
null | Entry<T>
An entry representing the value or class at the
specified path in the namespace. The method returns null
if the specified path does not exist in the namespace.
_isOptional()
_isOptional<
T>(name):boolean
Defined in: packages/core/src/oc/ObjectContainer.ts:594
Checks whether the name is marked as optional.
Type Parameters
• T
Parameters
name
Dependency<T>
Name of a constant or alias, factory function, class or interface constructor, or a fully qualified namespace path.
Returns
boolean
_isSpread()
_isSpread<
T>(name):boolean
Defined in: packages/core/src/oc/ObjectContainer.ts:608
Checks whether the name is marked as spread.
Type Parameters
• T
Parameters
name
Dependency<T>
Name of a constant or alias, factory function, class or interface constructor, or a fully qualified namespace path.
Returns
boolean
_updateEntryValues()
_updateEntryValues<
T,E>(entry,classConstructor,dependencies):void
Defined in: packages/core/src/oc/ObjectContainer.ts:627
The method update classConstructor and dependencies for defined entry. The entry throw Error for constants and if you try override dependencies more than once.
Type Parameters
• T
• E extends Entry<T>
Parameters
entry
E
The entry representing the class that should have its instance created or factory faction to use to create a value.
classConstructor
OCInjectable<T>
The class constructor or factory function.
dependencies
any[]
The dependencies to pass into the constructor or factory function.
Returns
void
bind()
bind<
T,C>(name,classConstructor,dependencies?):this
Defined in: packages/core/src/oc/ObjectContainer.ts:115
Binds the specified class or factory function and dependencies to the specified alias. Binding a class or factory function to an alias allows the class or function to be specified as a dependency by specifying the alias and creating new instances by referring to the class or function by the alias.
Also note that the same class or function may be bound to several aliases and each may use different dependencies.
The alias will use the default dependencies bound for the class if no dependencies are provided.
Type Parameters
• T extends keyof OCAliasMap
• C
Parameters
name
T
Alias name.
classConstructor
OCInjectable<C>
The class constructor or a factory function.
dependencies?
any[]
The dependencies to pass into the constructor or factory function.
Returns
this
This object container.
clear()
clear():
this
Defined in: packages/core/src/oc/ObjectContainer.ts:486
Clears all entries from this object container and resets the locking mechanism of this object container.
Returns
this
This object container.
constant()
constant<
T,V>(name,value):this
Defined in: packages/core/src/oc/ObjectContainer.ts:201
Defines a new constant registered with this object container. Note that
this is the only way of passing string values to constructors
because the object container treats strings as class, interface, alias
or constant names.
Type Parameters
• T extends keyof OCAliasMap
• V
Parameters
name
T
The constant name.
value
V
The constant value.
Returns
this
This object container.
create()
create<
T>(name,dependencies):OCInstance<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:464
Creates a new instance of the class or retrieves the value generated by the factory function identified by the provided name, class, interface, or factory function, passing in the provided dependencies.
The method uses the dependencies specified when the class, interface or factory function has been registered with the object container if no custom dependencies are provided.
Type Parameters
• T extends OCInstanceConstrain<any>
Parameters
name
T
The name of the alias, class, interface, or the class, interface or a factory function to use.
dependencies
any[] = []
The dependencies to pass into the constructor or factory function.
Returns
OCInstance<T>
Created instance or generated value.
get()
get<
T>(name):OCInstance<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:401
Retrieves the shared instance or value of the specified constant, alias, class or factory function, interface, or fully qualified namespace path (the method checks these in this order in case of a name clash).
The instance or value is created lazily the first time it is requested.
Type Parameters
• T extends OCInstanceConstrain<any>
Parameters
name
T
The name of the alias, class, interface, or the class, interface or a factory function.
Returns
OCInstance<T>
The shared instance or value.
getConstructorOf()
getConstructorOf<
T>(name):null|Constructor<T>
Defined in: packages/core/src/oc/ObjectContainer.ts:419
Returns the class constructor function of the specified class.
Type Parameters
• T extends keyof OCAliasMap | Constructor<any>
Parameters
name
T
The name by which the class is registered with this object container.
Returns
null | Constructor<T>
The constructor function.
has()
has<
T>(name):boolean
Defined in: packages/core/src/oc/ObjectContainer.ts:439
Returns true if the specified object, class or resource is
registered with this object container.
Type Parameters
• T
Parameters
name
The resource name.
keyof OCAliasMap | OCInjectable<T>
Returns
boolean
true if the specified object, class or
resource is registered with this object container.
inject()
inject<
T>(classConstructor,dependencies):this
Defined in: packages/core/src/oc/ObjectContainer.ts:245
Configures the object loader with the specified default dependencies for the specified class.
New instances of the class created by this object container will receive the provided dependencies into constructor unless custom dependencies are provided.
Type Parameters
• T
Parameters
classConstructor
Constructor<T>
The class constructor.
dependencies
any[]
The dependencies to pass into the constructor function.
Returns
this
This object container.
provide()
provide<
T,I>(interfaceConstructor,implementationConstructor,dependencies?):this
Defined in: packages/core/src/oc/ObjectContainer.ts:320
Configures the default implementation of the specified interface to use when an implementation provider of the specified interface is requested from this object container.
The implementation constructor will obtain the provided default dependencies or the dependencies provided to the () method.
Type Parameters
• T
• I
Parameters
interfaceConstructor
The constructor of the interface representing the service.
Constructor<I> | AbstractConstructor<I>
implementationConstructor
Constructor<T>
The constructor of the class implementing the service interface.
dependencies?
any[]
The dependencies to pass into the constructor function.
Returns
this
This object container.
setBindingState()
setBindingState(
bindingState,bindingPluginName?):void
Defined in: packages/core/src/oc/ObjectContainer.ts:494
Parameters
bindingState
bindingPluginName?
string
Returns
void