Class: BaseEntity<T, PK, P>#
core.BaseEntity
Type parameters#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
PK | keyof T | - |
P | Populate<T> | unknown | unknown |
Hierarchy#
- BaseEntity
Implements#
- IWrappedEntity<T, PK, P>
Constructors#
constructor#
+ new BaseEntity<T, PK, P>(): BaseEntity<T, PK, P>
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
PK | string | number | symbol | - |
P | unknown | unknown |
Returns: BaseEntity<T, PK, P>
Defined in: packages/core/src/entity/BaseEntity.ts:5
Methods#
assign#
â–¸ assign(data: EntityData<T>, options?: AssignOptions): T
Parameters:#
| Name | Type |
|---|---|
data | EntityData<T> |
options? | AssignOptions |
Returns: T
Defined in: packages/core/src/entity/BaseEntity.ts:35
init#
â–¸ init(populated?: boolean): Promise<T>
Parameters:#
| Name | Type | Default value |
|---|---|---|
populated | boolean | true |
Returns: Promise<T>
Defined in: packages/core/src/entity/BaseEntity.ts:39
isInitialized#
â–¸ isInitialized(): boolean
Returns: boolean
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:11
populated#
â–¸ populated(populated?: boolean): void
Parameters:#
| Name | Type | Default value |
|---|---|---|
populated | boolean | true |
Returns: void
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:15
toJSON#
â–¸ toJSON(...args: any[]): Dictionary<any>
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: Dictionary<any>
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:27
toObject#
â–¸ toObject(ignoreFields?: string[]): Dictionary<any>
Parameters:#
| Name | Type | Default value |
|---|---|---|
ignoreFields | string[] | ... |
Returns: Dictionary<any>
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:23
toPOJO#
â–¸ toPOJO(): EntityData<T>
Returns: EntityData<T>
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:31
toReference#
â–¸ toReference(): any
Returns: any
Implementation of: IWrappedEntity
Defined in: packages/core/src/entity/BaseEntity.ts:19