abstractHydrator

Abstract base class for hydrating entity instances from raw database data.

Implements

• IHydrator

Index

Constructors

• constructor

Methods

• hydrate
• hydrateReference
• isRunning

Constructors

constructor

• new Hydrator(metadata, platform, config): Hydrator

• Parameters

  • metadata: MetadataStorage

  • platform: Platform

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns Hydrator

Methods

hydrate

• hydrate<T>(entity, meta, data, factory, type, newEntity, convertCustomTypes, schema, parentSchema): void

• Implementation of IHydrator.hydrate

  @inheritDoc

  ---

  Parameters

  • entity: T

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

  • data: EntityData<T>

  • factory: EntityFactory

  • type: full | reference

  • newEntity: boolean = false

  • convertCustomTypes: boolean = false

  • optionalschema: string

  • optionalparentSchema: string

  Returns void

hydrateReference

• hydrateReference<T>(entity, meta, data, factory, convertCustomTypes, schema, parentSchema): void

• Implementation of IHydrator.hydrateReference

  @inheritDoc

  ---

  Parameters

  • entity: T

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

  • data: EntityData<T>

  • factory: EntityFactory

  • optionalconvertCustomTypes: boolean

  • optionalschema: string

  • optionalparentSchema: string

  Returns void

isRunning

• isRunning(): boolean

• Implementation of IHydrator.isRunning

  Returns whether the hydrator is currently in the middle of hydrating an entity.

  ---

  Returns boolean