Version: 4.3

Interface: IWrappedEntityInternal<T, PK, P>

Type parameters#

NameTypeDefault
T--
PKkeyof T-
P-keyof T

Hierarchy#

Properties#

__data#

__data: Dictionary

Defined in packages/core/src/typings.ts:95


__em#

Optional __em: any

Defined in packages/core/src/typings.ts:96


__identifier#

Optional __identifier: EntityIdentifier

Defined in packages/core/src/typings.ts:100


__initialized#

__initialized: boolean

Defined in packages/core/src/typings.ts:98


__lazyInitialized#

__lazyInitialized: boolean

Defined in packages/core/src/typings.ts:103


__managed#

__managed: boolean

Defined in packages/core/src/typings.ts:101


__meta#

__meta: EntityMetadata<T>

Defined in packages/core/src/typings.ts:94


__originalEntityData#

Optional __originalEntityData: EntityData<T>

Defined in packages/core/src/typings.ts:99


__platform#

__platform: Platform

Defined in packages/core/src/typings.ts:97


__populated#

__populated: boolean

Defined in packages/core/src/typings.ts:102


__primaryKeyCond#

__primaryKeyCond: Primary<T> | Primary<T>[]

Defined in packages/core/src/typings.ts:105


__primaryKeys#

__primaryKeys: Primary<T>[]

Defined in packages/core/src/typings.ts:104


__serializationContext#

__serializationContext: { populate?: PopulateOptions<T>[] ; root?: SerializationContext<T> }

Defined in packages/core/src/typings.ts:106

Type declaration:#

NameType
populate?PopulateOptions<T>[]
root?SerializationContext<T>

Methods#

assign#

assign(data: any, options?: AssignOptions | boolean): T

Inherited from IWrappedEntity.assign

Defined in packages/core/src/typings.ts:86

Parameters:#

NameType
dataany
options?AssignOptions | boolean

Returns: T


getPrimaryKey#

getPrimaryKey(): Primary<T>

Defined in packages/core/src/typings.ts:91

Returns: Primary<T>


getSerializedPrimaryKey#

getSerializedPrimaryKey(): string & keyof T

Defined in packages/core/src/typings.ts:93

Returns: string & keyof T


hasPrimaryKey#

hasPrimaryKey(): boolean

Defined in packages/core/src/typings.ts:90

Returns: boolean


init#

init<P>(populated?: boolean, populate?: P, lockMode?: LockMode): Promise<T>

Inherited from IWrappedEntity.init

Defined in packages/core/src/typings.ts:82

Type parameters:#

NameTypeDefault
PPopulate<T>Populate\<T>

Parameters:#

NameType
populated?boolean
populate?P
lockMode?LockMode

Returns: Promise<T>


isInitialized#

isInitialized(): boolean

Inherited from IWrappedEntity.isInitialized

Defined in packages/core/src/typings.ts:80

Returns: boolean


populated#

populated(populated?: boolean): void

Inherited from IWrappedEntity.populated

Defined in packages/core/src/typings.ts:81

Parameters:#

NameType
populated?boolean

Returns: void


setPrimaryKey#

setPrimaryKey(val: Primary<T>): void

Defined in packages/core/src/typings.ts:92

Parameters:#

NameType
valPrimary<T>

Returns: void


toJSON#

toJSON(...args: any[]): Dictionary

Inherited from IWrappedEntity.toJSON

Defined in packages/core/src/typings.ts:85

Parameters:#

NameType
...argsany[]

Returns: Dictionary


toObject#

toObject(ignoreFields?: string[]): Dictionary

Inherited from IWrappedEntity.toObject

Defined in packages/core/src/typings.ts:84

Parameters:#

NameType
ignoreFields?string[]

Returns: Dictionary


toReference#

toReference<PK2, P2>(): IdentifiedReference<T, PK2> & LoadedReference<T, P2>

Inherited from IWrappedEntity.toReference

Defined in packages/core/src/typings.ts:83

Type parameters:#

NameTypeDefault
PK2PK | unknownunknown
P2P | unknownunknown

Returns: IdentifiedReference<T, PK2> & LoadedReference<T, P2>

Last updated on by Renovate Bot