Version: 4.3

Interface: IWrappedEntity<T, PK, P>

Type parameters

NameTypeDefault
TAnyEntity<T>-
PKkeyof T-
PPopulate<T> | unknownunknown

Hierarchy

Implemented by

Methods

assign

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

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

Parameters:

NameType
dataany
options?AssignOptions | boolean

Returns: T


init

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

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

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

Returns: boolean


populated

populated(populated?: boolean): void

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

Parameters:

NameType
populated?boolean

Returns: void


toJSON

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

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

Parameters:

NameType
...argsany[]

Returns: Dictionary


toObject

toObject(ignoreFields?: string[]): Dictionary

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

Parameters:

NameType
ignoreFields?string[]

Returns: Dictionary


toReference

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

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 Martin Adámek