Interface: LoadedReference<T, P>#
core.LoadedReference
Type parameters#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
P | - | never |
Hierarchy#
Reference<T>
↳ LoadedReference
Properties#
$
• $: T & P
Defined in: packages/core/src/typings.ts:385
Methods#
get#
â–¸ get(): T & P
Returns: T & P
Defined in: packages/core/src/typings.ts:386
getEntity#
â–¸ getEntity(): T
Returns: T
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:108
getProperty#
â–¸ getProperty<K>(prop: K): T[K]
Type parameters:#
| Name | Type |
|---|---|
K | string | number | symbol |
Parameters:#
| Name | Type |
|---|---|
prop | K |
Returns: T[K]
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:116
isInitialized#
â–¸ isInitialized(): boolean
Returns: boolean
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:120
load#
â–¸ load(): Promise<T>
Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity.
Returns: Promise<T>
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:67
â–¸ load<K>(prop: K): Promise<T[K]>
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 | string | number | symbol |
Parameters:#
| Name | Type |
|---|---|
prop | K |
Returns: Promise<T[K]>
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:73
populated#
â–¸ populated(populated?: boolean): void
Parameters:#
| Name | Type |
|---|---|
populated? | boolean |
Returns: void
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:124
set#
â–¸ set(entity: T | IdentifiedReference<T, PrimaryProperty<T>>): void
Parameters:#
| Name | Type |
|---|---|
entity | T | IdentifiedReference<T, PrimaryProperty<T>> |
Returns: void
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:91
toJSON#
â–¸ toJSON(...args: any[]): Dictionary<any>
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: Dictionary<any>
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:128
unwrap#
â–¸ unwrap(): T
Returns: T
Inherited from: Reference
Defined in: packages/core/src/entity/Reference.ts:104