EntityFactory

Index

Constructors

• constructor

Methods

• create
• createEmbeddable
• createReference
• getComparator
• mergeData

Constructors

constructor

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

• Parameters

  • em: EntityManager<IDatabaseDriver<Connection>>

  Returns EntityFactory

Methods

create

• create(entityName: EntityName<T>, data: EntityData<T>, options?: FactoryOptions): New<T, P>

• Parameters

  • entityName: EntityName<T>

  • data: EntityData<T>

  • options: FactoryOptions = {}

  Returns New<T, P>

createEmbeddable

• createEmbeddable(entityName: EntityName<T>, data: EntityData<T>, options?: Pick<FactoryOptions, convertCustomTypes | newEntity>): T

• Parameters

  • entityName: EntityName<T>

  • data: EntityData<T>

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

  Returns T

createReference

• createReference(entityName: EntityName<T>, id: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T) | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[] | Record<string, T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T>, options?: Pick<FactoryOptions, schema | convertCustomTypes | merge>): T

• Parameters

  • entityName: EntityName<T>

  • id: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T) | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[] | Record<string, T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T>

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

  Returns T

getComparator

• getComparator(): EntityComparator

• Returns EntityComparator

mergeData

• mergeData(meta: EntityMetadata<T>, entity: T, data: EntityData<T>, options?: FactoryOptions): void

• Parameters

  • meta: EntityMetadata<T>

  • entity: T

  • data: EntityData<T>

  • options: FactoryOptions = {}

  Returns void