ManagedReferences

Managed references that in addition to keeping and locating references can also manage their lifecycle.

Implements: IOpenable

Description

The ManagedReferences class allows you to create managed references that in additon to keeping and locating references can also manage their lifecycle, such as:

Auto-creation of missing components using available factories
Auto-linking newly added components
Auto-opening newly added components
Auto-closing removed components

Constructors

Creates a new instance of the decorator.

public constructor(tuples: any[] = null)

tuples: any[] - tuples where odd values are component locators (descriptors) and even values are component references

Fields

_references

References

protected _references: References

_builder

Builder

protected _builder: BuildReferencesDecorator

_linker

Linker

protected _linker: LinkReferencesDecorator

_runner

Runner

protected _runner: RunReferencesDecorator

Instance methods

close

Closes the component and frees used resources.

public close(context: IContext): Promise<void>

context: IContext - (optional) a context to trace execution through a call chain.

isOpen

Checks if the component is open.

public isOpen(): boolean

returns: boolean - True if the component is open and False otherwise.

open

Opens the component.

public open(context: IContext): Promise<void>

context: IContext - (optional) a context to trace execution through a call chain.

Static methods

fromTuples

Removes all component references that match the specified locator.

public static fromTuples(…tuples: any[]): ManagedReferences

locator: any[] - locator to remove references by.
returns: ManagedReferences - list containing all removed references.