Class: Reference<T>
Type parameters#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Hierarchy#
Reference
↳ LoadedReference
Constructors#
constructor#
+ new Reference(entity: T): Reference
Defined in packages/core/src/entity/Reference.ts:6
Parameters:#
| Name | Type |
|---|---|
entity | T |
Returns: Reference
Properties#
entity#
• Private entity: T
Defined in packages/core/src/entity/Reference.ts:8
Methods#
getEntity#
â–¸ getEntity(): T
Defined in packages/core/src/entity/Reference.ts:108
Returns: T
getProperty#
â–¸ getProperty<K>(prop: K): T[K]
Defined in packages/core/src/entity/Reference.ts:116
Type parameters:#
| Name | Type |
|---|---|
K | keyof T |
Parameters:#
| Name | Type |
|---|---|
prop | K |
Returns: T[K]
isInitialized#
â–¸ isInitialized(): boolean
Defined in packages/core/src/entity/Reference.ts:120
Returns: boolean
load#
â–¸ load(): Promise<T>
Defined in packages/core/src/entity/Reference.ts:67
Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity.
Returns: Promise<T>
â–¸ load<K>(prop: K): Promise<T[K]>
Defined in packages/core/src/entity/Reference.ts:73
Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the requested property instead of the whole entity.
Type parameters:#
| Name | Type |
|---|---|
K | keyof T |
Parameters:#
| Name | Type |
|---|---|
prop | K |
Returns: Promise<T[K]>
populated#
â–¸ populated(populated?: boolean): void
Defined in packages/core/src/entity/Reference.ts:124
Parameters:#
| Name | Type |
|---|---|
populated? | boolean |
Returns: void
set#
â–¸ set(entity: T | IdentifiedReference<T>): void
Defined in packages/core/src/entity/Reference.ts:91
Parameters:#
| Name | Type |
|---|---|
entity | T | IdentifiedReference<T> |
Returns: void
toJSON#
â–¸ toJSON(...args: any[]): Dictionary
Defined in packages/core/src/entity/Reference.ts:128
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: Dictionary
unwrap#
â–¸ unwrap(): T
Defined in packages/core/src/entity/Reference.ts:104
Returns: T
create#
â–¸ Staticcreate<T, PK>(entity: T | IdentifiedReference<T, PK>): IdentifiedReference<T, PK>
Defined in packages/core/src/entity/Reference.ts:30
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
PK | keyof T | unknown | PrimaryProperty\<T> |
Parameters:#
| Name | Type |
|---|---|
entity | T | IdentifiedReference<T, PK> |
Returns: IdentifiedReference<T, PK>
isReference#
â–¸ StaticisReference<T>(data: any): data is Reference<T>
Defined in packages/core/src/entity/Reference.ts:41
Checks whether the argument is instance or Reference wrapper.
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
data | any |
Returns: data is Reference<T>
unwrapReference#
â–¸ StaticunwrapReference<T>(ref: T | Reference<T>): T
Defined in packages/core/src/entity/Reference.ts:59
Returns wrapped entity.
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
ref | T | Reference<T> |
Returns: T
wrapReference#
â–¸ StaticwrapReference<T>(entity: T | Reference<T>, prop: EntityProperty<T>): Reference<T> | T
Defined in packages/core/src/entity/Reference.ts:48
Wraps the entity in a Reference wrapper if the property is defined as wrappedReference.
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entity | T | Reference<T> |
prop | EntityProperty<T> |
Returns: Reference<T> | T