MetadataStorage

Registry that stores and provides access to entity metadata by class, name, or id.

Index

Constructors

• constructor

Properties

• PATH_SYMBOL

Methods

• [iterator]
• decorate
• find
• get
• getAll
• getByClassName
• getById
• getByUniqueName
• has
• reset
• set
• clear
• getMetadata
• isKnownEntity

Constructors

constructor

• new MetadataStorage(metadata): MetadataStorage

• Parameters

  • metadata: Dictionary<EntityMetadata<any, EntityCtor<any>>> = {}

  Returns MetadataStorage

Properties

staticreadonlyPATH_SYMBOL

PATH_SYMBOL: typeof PATH_SYMBOL = ...

Methods

[iterator]

• [iterator](): IterableIterator<EntityMetadata<any, EntityCtor<any>>, any, any>

• Returns IterableIterator<EntityMetadata<any, EntityCtor<any>>, any, any>

decorate

• decorate(em): void

• Decorates all entity prototypes with helper methods (e.g. init, toJSON).

  ---

  Parameters

  • em: EntityManager<IDatabaseDriver<Connection>>

  Returns void

find

• find<T>(entityName): undefined | EntityMetadata<T, EntityCtor<T>>

• Finds metadata for the given entity, returning undefined if not registered.

  ---

  Parameters

  • entityName: EntityName<T>

  Returns undefined | EntityMetadata<T, EntityCtor<T>>

get

• get<T>(entityName, init): EntityMetadata<T, EntityCtor<T>>

• Returns metadata for the given entity, optionally initializing it if not found.

  ---

  Parameters

  • entityName: EntityName<T>

  • init: boolean = false

  Returns EntityMetadata<T, EntityCtor<T>>

getAll

• getAll(): Map<EntityName, EntityMetadata<any, EntityCtor<any>>>

• Returns the map of all registered entity metadata.

  ---

  Returns Map<EntityName, EntityMetadata<any, EntityCtor<any>>>

getByClassName

• getByClassName<T, V>(className, validate): V extends true ? EntityMetadata<T, EntityCtor<T>> : undefined | EntityMetadata<T, EntityCtor<T>>

• Returns metadata by class name, optionally throwing if not found.

  ---

  Parameters

  • className: string

  • validate: V = ...

  Returns V extends true ? EntityMetadata<T, EntityCtor<T>> : undefined | EntityMetadata<T, EntityCtor<T>>

getById

• getById<T>(id): EntityMetadata<T, EntityCtor<T>>

• Returns metadata by its internal numeric id.

  ---

  Parameters

  • id: number

  Returns EntityMetadata<T, EntityCtor<T>>

getByUniqueName

• getByUniqueName<T, V>(uniqueName, validate): V extends true ? EntityMetadata<T, EntityCtor<T>> : undefined | EntityMetadata<T, EntityCtor<T>>

• Returns metadata by unique name, optionally throwing if not found.

  ---

  Parameters

  • uniqueName: string

  • validate: V = ...

  Returns V extends true ? EntityMetadata<T, EntityCtor<T>> : undefined | EntityMetadata<T, EntityCtor<T>>

has

• has<T>(entityName): boolean

• Checks whether metadata exists for the given entity.

  ---

  Parameters

  • entityName: EntityName<T>

  Returns boolean

reset

• reset<T>(entityName): void

• Removes metadata for the given entity from all internal maps.

  ---

  Parameters

  • entityName: EntityName<T>

  Returns void

set

• set<T>(entityName, meta): EntityMetadata<any, EntityCtor<any>>

• Registers metadata for the given entity.

  ---

  Parameters

  • entityName: EntityName<T>

  • meta: EntityMetadata<any, EntityCtor<any>>

  Returns EntityMetadata<any, EntityCtor<any>>

staticclear

• clear(): void

• Clears all entries from the global metadata registry.

  ---

  Returns void

staticgetMetadata

• getMetadata(): Dictionary<EntityMetadata<any, EntityCtor<any>>>
• getMetadata<T>(entity, path): EntityMetadata<T, EntityCtor<T>>

• Returns the global metadata dictionary, or a specific entry by entity name and path.

  ---

  Returns Dictionary<EntityMetadata<any, EntityCtor<any>>>

staticisKnownEntity

• isKnownEntity(name): boolean

• Checks whether an entity with the given class name exists in the global metadata.

  ---

  Parameters

  • name: string

  Returns boolean