Configuration <D, EM>

Index

Constructors

• constructor

Methods

• get
• getAll
• getCachedService
• getComparator
• getDataloaderType
• getDriver
• getExtension
• getHydrator
• getLogger
• getMetadataCacheAdapter
• getMetadataProvider
• getNamingStrategy
• getPlatform
• getRepositoryClass
• getResultCacheAdapter
• getSchema
• registerExtension
• reset
• resetServiceCache
• set

Constructors

constructor

• new Configuration<D, EM>(options, validate): Configuration<D, EM>

• Parameters

  • options: Options<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>

  • validate: boolean = true

  Returns Configuration<D, EM>

Methods

get

• get<T, U>(key, defaultValue): U

• Gets specific configuration option. Falls back to specified defaultValue if provided.

  ---

  Parameters

  • key: T

  • optionaldefaultValue: U

  Returns U

getAll

• getAll(): RequiredOptions<D, EM, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>

• Returns RequiredOptions<D, EM, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>

getCachedService

• getCachedService<T>(cls, ...args): InstanceType<T>

• Creates instance of given service and caches it.

  ---

  Parameters

  • cls: T

  • rest...args: ConstructorParameters<T>

  Returns InstanceType<T>

getComparator

• getComparator(metadata): EntityComparator

• Gets instance of Comparator. (cached)

  ---

  Parameters

  • metadata: MetadataStorage

  Returns EntityComparator

getDataloaderType

• getDataloaderType(): DataloaderType

• Returns DataloaderType

getDriver

• getDriver(): D

• Gets current database driver instance.

  ---

  Returns D

getExtension

• getExtension<T>(name): undefined | T

• Parameters

  • name: string

  Returns undefined | T

getHydrator

• getHydrator(metadata): IHydrator

• Gets instance of Hydrator. (cached)

  ---

  Parameters

  • metadata: MetadataStorage

  Returns IHydrator

getLogger

• getLogger(): Logger

• Gets Logger instance.

  ---

  Returns Logger

getMetadataCacheAdapter

• getMetadataCacheAdapter(): SyncCacheAdapter

• Gets instance of metadata CacheAdapter. (cached)

  ---

  Returns SyncCacheAdapter

getMetadataProvider

• getMetadataProvider(): MetadataProvider

• Gets instance of MetadataProvider. (cached)

  ---

  Returns MetadataProvider

getNamingStrategy

• getNamingStrategy(): NamingStrategy

• Gets instance of NamingStrategy. (cached)

  ---

  Returns NamingStrategy

getPlatform

• getPlatform(): ReturnType<D[getPlatform]>

• Returns ReturnType<D[getPlatform]>

getRepositoryClass

• getRepositoryClass(repository): undefined | EntityClass<EntityRepository<any>>

• Gets EntityRepository class to be instantiated.

  ---

  Parameters

  • repository: () => EntityClass<EntityRepository<Partial<any>>>

  Returns undefined | EntityClass<EntityRepository<any>>

getResultCacheAdapter

• getResultCacheAdapter(): CacheAdapter

• Gets instance of CacheAdapter for result cache. (cached)

  ---

  Returns CacheAdapter

getSchema

• getSchema(skipDefaultSchema): undefined | string

• Parameters

  • skipDefaultSchema: boolean = false

  Returns undefined | string

registerExtension

• registerExtension(name, cb): void

• Parameters

  • name: string

  • cb: () => unknown

  Returns void

reset

• reset<T>(key): void

• Resets the configuration to its default value

  ---

  Parameters

  • key: T

  Returns void

resetServiceCache

• resetServiceCache(): void

• Returns void

set

• set<T, U>(key, value): void

• Overrides specified configuration value.

  ---

  Parameters

  • key: T

  • value: U

  Returns void