Class ConstructorInstanceMap

Map all ancestor constructors of an object to a set of objects.

Index

Constructors

Properties

isDestroyed map topMostConstructor?

Methods

add destroy getInstances remove traverseConstructors

Constructors

constructor

new ConstructorInstanceMap(
topMostConstructor?: Function,
): ConstructorInstanceMap
Parameters
- OptionaltopMostConstructor: Function
  The top most constructor to allow in the map. If this constructor is ever reached, the recursive mapping stops.
Returns ConstructorInstanceMap
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:18

Properties

`Readonly`isDestroyed

isDestroyed: boolean = false

`Readonly`map

map: Map<Function, Set<AnyObject>> = ...

A map of constructors to their added instances.

`Protected` `Optional` `Readonly`topMostConstructor

topMostConstructor?: Function

The top most constructor to allow in the map. If this constructor is ever reached, the recursive mapping stops.

Methods

add

add(instance: AnyObject): void
Add a new instance, mapping each of its ancestor constructors to it inside ConstructorInstanceMap.map.
Parameters
- instance: AnyObject
Returns void
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:30

destroy

destroy(): void
Clean up the internal map.

Returns void
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:83

getInstances

getInstances<T>(constructor: AbstractConstructor<T> | Constructor<T>): Set<T>
Gets all added instances of the given constructor.
Type Parameters
- T
Parameters
- constructor: AbstractConstructor<T> | Constructor<T>
Returns Set<T>
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:38

remove

remove(instance: AnyObject): void
Remove an instance, removing it from all mappings inside ConstructorInstanceMap.map.
Parameters
- instance: AnyObject
Returns void
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:46

`Protected`traverseConstructors

traverseConstructors(
    instance: AnyObject,
    prototype: any,
    operation: "add" | "remove",
): void
Recursively map all ancestor prototypes to the given instance.
Parameters
- instance: AnyObject
- prototype: any
- operation: "add" | "remove"
Returns void
- Defined in packages/common/src/augments/object/constructor-instance-map.ts:54