Skip to main content
Version: 5.9

EntityFactory

Index

Constructors

Methods

Constructors

constructor

  • new EntityFactory(em: EntityManager<IDatabaseDriver<Connection>>): EntityFactory

  • Parameters

    • em: EntityManager<IDatabaseDriver<Connection>>

    Returns EntityFactory

Methods

create

  • create<T, P>(entityName: EntityName<T>, data: EntityData<T>, options?: FactoryOptions): 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: EntityName<T>, data: EntityData<T>, options?: Pick<FactoryOptions, convertCustomTypes | newEntity>): T

  • Type parameters

    • T: object

    Parameters

    • entityName: EntityName<T>
    • data: EntityData<T>
    • options: Pick<FactoryOptions, convertCustomTypes | newEntity> = {}

    Returns T

createReference

  • createReference<T>(entityName: EntityName<T>, id: Primary<T> | Primary<T>[] | Record<string, Primary<T>>, options?: Pick<FactoryOptions, schema | convertCustomTypes | merge>): 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: EntityMetadata<T>, entity: T, data: EntityData<T>, options?: FactoryOptions): void

  • Type parameters

    • T: object

    Parameters

    • meta: EntityMetadata<T>
    • entity: T
    • data: EntityData<T>
    • options: FactoryOptions = {}

    Returns void

Page Options