Interface: IWrappedEntity<T, PK, P>

core.IWrappedEntity

Type parameters

Name	Type	Default
T	AnyEntity<T>	-
PK	keyof T	-
P	Populate<T> | unknown	unknown

Hierarchy

• IWrappedEntity

Implemented by

• BaseEntity

Methods

assign

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

Parameters:

Name	Type
data	any
options?	boolean | AssignOptions

Returns: T

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

---

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
populated?	boolean
populate?	P
lockMode?	NONE | OPTIMISTIC | PESSIMISTIC_READ | PESSIMISTIC_WRITE

Returns: Promise<T>

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

---

isInitialized

▸ isInitialized(): boolean

Returns: boolean

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

---

populated

▸ populated(populated?: boolean): void

Parameters:

Name	Type
populated?	boolean

Returns: void

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

---

toJSON

▸ toJSON(...args: any[]): Dictionary<any>

Parameters:

Name	Type
...args	any[]

Returns: Dictionary<any>

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

---

toObject

▸ toObject(ignoreFields?: string[]): Dictionary<any>

Parameters:

Name	Type
ignoreFields?	string[]

Returns: Dictionary<any>

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

---

toPOJO

▸ toPOJO(): EntityData<T>

Returns: EntityData<T>

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

---

toReference

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

Type parameters:

Name	Type	Default
PK2	unknown	PrimaryProperty<T\>
P2	unknown	unknown

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

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