TsMorphMetadataProvider

Metadata provider that uses ts-morph to infer property types from TypeScript source files or declaration files.

Hierarchy

• MetadataProvider
  • TsMorphMetadataProvider

Index

Constructors

• constructor

Methods

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

Constructors

constructor

• new TsMorphMetadataProvider(config): TsMorphMetadataProvider

• Inherited from MetadataProvider.constructor

  Parameters

  • config: IConfiguration

  Returns TsMorphMetadataProvider

Methods

inheritedcombineCache

• combineCache(): void

• Inherited from MetadataProvider.combineCache

  Combines individual metadata cache entries into a single file.

  ---

  Returns void

inheritedgetCachedMetadata

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

• Inherited from MetadataProvider.getCachedMetadata

  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

• Overrides MetadataProvider.getCacheKey

  Returns the cache key for the given entity metadata.

  ---

  Parameters

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

  Returns string

getExistingSourceFile

• getExistingSourceFile(path, ext, validate): SourceFile

• Parameters

  • path: string

  • optionalext: string

  • validate: boolean = true

  Returns SourceFile

loadEntityMetadata

• loadEntityMetadata(meta): void

• Overrides MetadataProvider.loadEntityMetadata

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

  ---

  Parameters

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

  Returns void

inheritedloadFromCache

• loadFromCache(meta, cache): void

• Inherited from MetadataProvider.loadFromCache

  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

• Overrides MetadataProvider.saveToCache

  Parameters

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

  Returns void

useCache

• useCache(): boolean

• Overrides MetadataProvider.useCache

  Whether metadata caching is enabled for this instance.

  ---

  Returns boolean

staticuseCache

• useCache(): boolean

• Overrides MetadataProvider.useCache

  Whether this provider class uses metadata caching by default.

  ---

  Returns boolean