MetadataProvider

Base metadata provider that resolves entity type information and manages metadata caching.

Hierarchy

• MetadataProvider
  • TsMorphMetadataProvider

Index

Constructors

• constructor

Methods

• combineCache
• getCachedMetadata
• getCacheKey
• loadEntityMetadata
• loadFromCache
• saveToCache
• useCache
• useCache

Constructors

constructor

• new MetadataProvider(config): MetadataProvider

• Parameters

  • config: IConfiguration

  Returns MetadataProvider

Methods

combineCache

• combineCache(): void

• Combines individual metadata cache entries into a single file.

  ---

  Returns void

getCachedMetadata

• getCachedMetadata<T>(meta, root): undefined | EntityMetadata<T, EntityCtor<T>>

• Attempts to load metadata from cache, returning undefined if not available.

  ---

  Parameters

  • meta: Pick<EntityMetadata<T, EntityCtor<T>>, className | path | root>

  • root: EntityMetadata<T, EntityCtor<T>>

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

getCacheKey

• getCacheKey(meta): string

• Returns the cache key for the given entity metadata.

  ---

  Parameters

  • meta: Pick<EntityMetadata<any, EntityCtor<any>>, className | path>

  Returns string

loadEntityMetadata

• loadEntityMetadata(meta): void

• Resolves entity references and type information for all properties in the given metadata.

  ---

  Parameters

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

  Returns void

loadFromCache

• loadFromCache(meta, cache): void

• Merges cached metadata into the given entity metadata, preserving function expressions.

  ---

  Parameters

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

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

  Returns void

saveToCache

• saveToCache(meta): void

• Parameters

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

  Returns void

useCache

• useCache(): boolean

• Whether metadata caching is enabled for this instance.

  ---

  Returns boolean

staticuseCache

• useCache(): boolean

• Whether this provider class uses metadata caching by default.

  ---

  Returns boolean