EntityFactory

Index

Constructors

• constructor

Methods

• create
• createEmbeddable
• createReference
• getComparator
• mergeData

Constructors

constructor

• new EntityFactory(em): EntityFactory

• Parameters

  • em: EntityManager<IDatabaseDriver<Connection>>

  Returns EntityFactory

Methods

create

• create<T, P>(entityName, data, options): New<T, P>

• Type parameters

  • T: object
  • P: string = string

  Parameters

  • entityName: EntityName<T>

  • data: EntityData<T>

  • options: FactoryOptions = {}

  Returns New<T, P>

createEmbeddable

• createEmbeddable<T>(entityName, data, options): T

• Type parameters

  • T: object

  Parameters

  • entityName: EntityName<T>

  • data: EntityData<T>

  • options: Pick<FactoryOptions, convertCustomTypes | newEntity> = {}

  Returns T

createReference

• createReference<T>(entityName, id, options): T

• Type parameters

  • T: object

  Parameters

  • entityName: EntityName<T>

  • id: Primary<T> | Primary<T>[] | Record<string, Primary<T>>

  • options: Pick<FactoryOptions, schema | convertCustomTypes | merge> = {}

  Returns T

getComparator

• getComparator(): EntityComparator

• Returns EntityComparator

mergeData

• mergeData<T>(meta, entity, data, options): void

• Type parameters

  • T: object

  Parameters

  • meta: EntityMetadata<T>

  • entity: T

  • data: EntityData<T>

  • options: FactoryOptions = {}

  Returns void