Skip to main content

Class: ComponentUtils

@ima/core.ComponentUtils

Constructors

constructor

new ComponentUtils(oc)

Initializes the registry used for managing component utils.

Parameters

NameTypeDescription
ocObjectContainerThe application's dependency injector - the object container.

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:34

Properties

_oc

Private _oc: ObjectContainer

The application's dependency injector - the object container.

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:11


_utilities

Private Optional _utilities: UnknownParameters

Map of instantiated utilities

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:21


_utilityClasses

Private _utilityClasses: Object = {}

Map of registered utilities.

Index signature

[key: string]: UnknownConstructable | FactoryFunction

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:15


_utilityReferrers

Private _utilityReferrers: StringParameters = {}

Map of referrers to utilities

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:26

Methods

_createUtilityInstance

_createUtilityInstance(alias, utilityClass): unknown

Parameters

NameType
aliasstring
utilityClassUnknownConstructable | FactoryFunction

Returns

unknown

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:113


getReferrers

getReferrers(): StringParameters

Returns

StringParameters

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:109


getUtils

getUtils(): UnknownParameters

Returns object containing all registered utilities

Returns

UnknownParameters

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:89


register

register(name, componentUtilityClass?, referrer?): void

Registers single utility class or multiple classes in alias->class mapping.

Parameters

NameType
namestring | UnknownConstructable | FactoryFunction | { [key: string]: string | UnknownConstructable | FactoryFunction; }
componentUtilityClass?UnknownConstructable | FactoryFunction
referrer?string

Returns

void

Defined in

packages/core/src/page/renderer/ComponentUtils.ts:41