WrappedEntity <Entity>

Index

Constructors

• constructor

Properties

• __data
• __em
• __identifier
• __initialized
• __loadedProperties
• __managed
• __onLoadFired
• __originalEntityData
• __pk
• __populated
• __processing
• __reference
• __schema
• __serializationContext
• __touched

Accessors

• __config
• __meta
• __platform
• __primaryKeys

Methods

• assign
• getPrimaryKey
• getPrimaryKeys
• getSchema
• getSerializedPrimaryKey
• hasPrimaryKey
• init
• isInitialized
• isManaged
• isTouched
• populate
• populated
• serialize
• setPrimaryKey
• setSchema
• setSerializationContext
• toJSON
• toObject
• toPOJO
• toReference

Constructors

constructor

• new WrappedEntity(entity: Entity, hydrator: IHydrator, pkGetter?: (e: Entity) => Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity, pkSerializer?: (e: Entity) => string, pkGetterConverted?: (e: Entity) => Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity): WrappedEntity<Entity>

• Parameters

  • entity: Entity

  • hydrator: IHydrator

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

  • optionalpkSerializer: (e: Entity) => string

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

  Returns WrappedEntity<Entity>

Properties

__data

__data: Dictionary

optional__em

__em?: EntityManager<IDatabaseDriver<Connection>>

optional__identifier

__identifier?: EntityIdentifier

holds wrapped primary key, so we can compute change set without eager commit

__initialized

__initialized: boolean

__loadedProperties

__loadedProperties: Set<string>

optional__managed

__managed?: boolean

optional__onLoadFired

__onLoadFired?: boolean

optional__originalEntityData

__originalEntityData?: EntityData<Entity>

holds last entity data snapshot, so we can compute changes when persisting managed entities

optional__pk

__pk?: Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity

stores last known primary key, as its current state might be broken due to propagation/orphan removal, but we need to know the PK to be able t remove the entity

optional__populated

__populated?: boolean

__processing

__processing: boolean

optional__reference

__reference?: Reference<Entity>

holds the reference wrapper instance (if created), so we can maintain the identity on reference wrappers too

optional__schema

__schema?: string

__serializationContext

__serializationContext: { exclude?: readonly string[]; fields?: Set<string>; populate?: PopulateOptions<Entity>[]; root?: SerializationContext<Entity> }

Type declaration

• optionalexclude?: readonly string[]

• optionalfields?: Set<string>

• optionalpopulate?: PopulateOptions<Entity>[]

• optionalroot?: SerializationContext<Entity>

__touched

__touched: boolean

Accessors

__config

• get __config(): Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

• Returns Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

__meta

• get __meta(): EntityMetadata<Entity>

• Returns EntityMetadata<Entity>

__platform

• get __platform(): Platform

• Returns Platform

__primaryKeys

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

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

Methods

assign

• assign(data: Data & IsSubset<EntityData<Naked>, Data>, options?: AssignOptions<Convert>): MergeSelected<Entity, Naked, keyof Data & string>

• Parameters

  • data: Data & IsSubset<EntityData<Naked>, Data>

  • optionaloptions: AssignOptions<Convert>

  Returns MergeSelected<Entity, Naked, keyof Data & string>

getPrimaryKey

• getPrimaryKey(convertCustomTypes?: boolean): null | (Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity)

• Parameters

  • convertCustomTypes: boolean = false

  Returns null | (Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity)

getPrimaryKeys

• getPrimaryKeys(convertCustomTypes?: boolean): null | (Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity)[]

• Parameters

  • convertCustomTypes: boolean = false

  Returns null | (Entity extends { [PrimaryKeyProp]?: PK } ? PK extends keyof Entity<Entity> ? ReadonlyPrimary<UnwrapPrimary<Entity<Entity>[PK<PK>]>> : PK extends keyof Entity<Entity>[] ? ReadonlyPrimary<PrimaryPropToType<Entity<Entity>, PK<PK>>> : PK : Entity extends { _id?: PK } ? string | ReadonlyPrimary<PK> : Entity extends { uuid?: PK } ? ReadonlyPrimary<PK> : Entity extends { id?: PK } ? ReadonlyPrimary<PK> : Entity)[]

getSchema

• getSchema(): undefined | string

• Returns undefined | string

getSerializedPrimaryKey

• getSerializedPrimaryKey(): string

• Returns string

hasPrimaryKey

• hasPrimaryKey(): boolean

• Returns boolean

init

• init(options?: FindOneOptions<Entity, Hint, Fields, Excludes>): Promise<null | Loaded<Entity, Hint, Fields, Excludes>>

• Parameters

  • optionaloptions: FindOneOptions<Entity, Hint, Fields, Excludes>

  Returns Promise<null | Loaded<Entity, Hint, Fields, Excludes>>

isInitialized

• isInitialized(): boolean

• Returns boolean

isManaged

• isManaged(): boolean

• Returns boolean

isTouched

• isTouched(): boolean

• Returns boolean

populate

• populate(populate: false | AutoPath<Entity, Hint, ALL>[], options?: EntityLoaderOptions<Entity>): Promise<Loaded<Entity, Hint>>

• Parameters

  • populate: false | AutoPath<Entity, Hint, ALL>[]

  • options: EntityLoaderOptions<Entity> = {}

  Returns Promise<Loaded<Entity, Hint>>

populated

• populated(populated?: undefined | boolean): void

• Parameters

  • populated: undefined | boolean = true

  Returns void

serialize

• serialize(options?: SerializeOptions<Entity, Hint, Exclude>): EntityDTO<Loaded<Entity, Hint>>

• Parameters

  • optionaloptions: SerializeOptions<Entity, Hint, Exclude>

  Returns EntityDTO<Loaded<Entity, Hint>>

setPrimaryKey

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

• Parameters

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

  Returns void

setSchema

• setSchema(schema?: string): void

• Parameters

  • optionalschema: string

  Returns void

setSerializationContext

• setSerializationContext(options: LoadHint<Entity, Hint, Fields, Exclude>): void

• Parameters

  • options: LoadHint<Entity, Hint, Fields, Exclude>

  Returns void

toJSON

• toJSON(...args: any[]): EntityDictionary<Entity>

• Parameters

  • rest...args: any[]

  Returns EntityDictionary<Entity>

toObject

• toObject(ignoreFields?: Ignored[]): Omit<EntityDTO<Entity>, Ignored>

• Parameters

  • optionalignoreFields: Ignored[]

  Returns Omit<EntityDTO<Entity>, Ignored>

toPOJO

• toPOJO(): EntityDTO<Entity>

• Returns EntityDTO<Entity>

toReference

• toReference(): Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>

• Returns Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>