#
Class: WrappedEntity<T, PK>core.WrappedEntity
#
Type parametersName | Type |
---|---|
T | AnyEntity<T> |
PK | keyof T |
#
Hierarchy- WrappedEntity
#
Constructors#
constructor+ new WrappedEntity<T, PK>(entity
: T, pkGetter
: (e
: T) => Primary<T>, pkSerializer
: (e
: T) => string): WrappedEntity<T, PK>
#
Type parameters:Name | Type |
---|---|
T | AnyEntity<T> |
PK | string | number | symbol |
#
Parameters:Name | Type |
---|---|
entity | T |
pkGetter | (e : T) => Primary<T> |
pkSerializer | (e : T) => string |
Returns: WrappedEntity<T, PK>
Defined in: packages/core/src/entity/WrappedEntity.ts:24
#
Properties#
__em• Optional
__em: undefined | EntityManager<IDatabaseDriver<Connection>>
Defined in: packages/core/src/entity/WrappedEntity.ts:17
#
__identifier• Optional
__identifier: undefined | EntityData<T>
holds wrapped primary key so we can compute change set without eager commit
Defined in: packages/core/src/entity/WrappedEntity.ts:24
#
__initialized• __initialized: boolean= true
Defined in: packages/core/src/entity/WrappedEntity.ts:13
#
__lazyInitialized• Optional
__lazyInitialized: undefined | boolean
Defined in: packages/core/src/entity/WrappedEntity.ts:15
#
__managed• Optional
__managed: undefined | boolean
Defined in: packages/core/src/entity/WrappedEntity.ts:16
#
__originalEntityData• Optional
__originalEntityData: undefined | EntityData<T>
holds last entity data snapshot so we can compute changes when persisting managed entities
Defined in: packages/core/src/entity/WrappedEntity.ts:21
#
__populated• Optional
__populated: undefined | boolean
Defined in: packages/core/src/entity/WrappedEntity.ts:14
#
__serializationContext• __serializationContext: { populate?
: undefined | PopulateOptions<T>[] ; root?
: undefined | SerializationContext<T> }
#
Type declaration:Name | Type |
---|---|
populate? | undefined | PopulateOptions<T>[] |
root? | undefined | SerializationContext<T> |
Defined in: packages/core/src/entity/WrappedEntity.ts:18
#
Accessors#
__meta• __meta(): EntityMetadata<T>
Returns: EntityMetadata<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:93
#
__platform• __platform(): Platform
Returns: Platform
Defined in: packages/core/src/entity/WrappedEntity.ts:97
#
__primaryKeyCond• __primaryKeyCond(): null | Primary<T> | Primary<T>[]
Returns: null | Primary<T> | Primary<T>[]
Defined in: packages/core/src/entity/WrappedEntity.ts:105
#
__primaryKeys• __primaryKeys(): Primary<T>[]
Returns: Primary<T>[]
Defined in: packages/core/src/entity/WrappedEntity.ts:101
#
Methods#
__@custom@36825â–¸ __@custom@36825(): string
Returns: string
Defined in: packages/core/src/entity/WrappedEntity.ts:113
#
assignâ–¸ assign(data
: EntityData<T>, options?
: AssignOptions): T
#
Parameters:Name | Type |
---|---|
data | EntityData<T> |
options? | AssignOptions |
Returns: T
Defined in: packages/core/src/entity/WrappedEntity.ts:56
#
getPrimaryKeyâ–¸ getPrimaryKey(): null | Primary<T>
Returns: null | Primary<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:81
#
getSerializedPrimaryKeyâ–¸ getSerializedPrimaryKey(): string
Returns: string
Defined in: packages/core/src/entity/WrappedEntity.ts:89
#
hasPrimaryKeyâ–¸ hasPrimaryKey(): boolean
Returns: boolean
Defined in: packages/core/src/entity/WrappedEntity.ts:76
#
initâ–¸ init<P>(populated?
: boolean, populate?
: P, lockMode?
: NONE | OPTIMISTIC | PESSIMISTIC_READ | PESSIMISTIC_WRITE): Promise<T>
#
Type parameters:Name | Type | Default |
---|---|---|
P | Populate<T> | Populate<T\> |
#
Parameters:Name | Type | Default value |
---|---|---|
populated | boolean | true |
populate? | P | - |
lockMode? | NONE | OPTIMISTIC | PESSIMISTIC_READ | PESSIMISTIC_WRITE | - |
Returns: Promise<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:64
#
isInitializedâ–¸ isInitialized(): boolean
Returns: boolean
Defined in: packages/core/src/entity/WrappedEntity.ts:30
#
populatedâ–¸ populated(populated?
: boolean): void
#
Parameters:Name | Type | Default value |
---|---|---|
populated | boolean | true |
Returns: void
Defined in: packages/core/src/entity/WrappedEntity.ts:34
#
setPrimaryKeyâ–¸ setPrimaryKey(id
: null | Primary<T>): void
#
Parameters:Name | Type |
---|---|
id | null | Primary<T> |
Returns: void
Defined in: packages/core/src/entity/WrappedEntity.ts:85
#
toJSONâ–¸ toJSON(...args
: any[]): EntityData<T>
#
Parameters:Name | Type |
---|---|
...args | any[] |
Returns: EntityData<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:51
#
toObjectâ–¸ toObject(ignoreFields?
: string[]): EntityData<T>
#
Parameters:Name | Type | Default value |
---|---|---|
ignoreFields | string[] | ... |
Returns: EntityData<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:43
#
toPOJOâ–¸ toPOJO(): EntityData<T>
Returns: EntityData<T>
Defined in: packages/core/src/entity/WrappedEntity.ts:47
#
toReferenceâ–¸ toReference(): IdentifiedReference<T, PK>
Returns: IdentifiedReference<T, PK>
Defined in: packages/core/src/entity/WrappedEntity.ts:39