Class: Reference<T>#
core.Reference
Type parameters#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Hierarchy#
Reference
↳ LoadedReference
Constructors#
constructor#
+ new Reference<T>(entity: T): Reference<T>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entity | T |
Returns: Reference<T>
Defined in: packages/core/src/entity/Reference.ts:6
Methods#
getEntity#
â–¸ getEntity(): T
Returns: T
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]
Defined in: packages/core/src/entity/Reference.ts:116
isInitialized#
â–¸ isInitialized(): boolean
Returns: boolean
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>
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]>
Defined in: packages/core/src/entity/Reference.ts:73
populated#
â–¸ populated(populated?: boolean): void
Parameters:#
| Name | Type |
|---|---|
populated? | boolean |
Returns: void
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
Defined in: packages/core/src/entity/Reference.ts:91
toJSON#
â–¸ toJSON(...args: any[]): Dictionary<any>
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: Dictionary<any>
Defined in: packages/core/src/entity/Reference.ts:128
unwrap#
â–¸ unwrap(): T
Returns: T
Defined in: packages/core/src/entity/Reference.ts:104
create#
â–¸ Staticcreate<T, PK>(entity: T | IdentifiedReference<T, PK>): IdentifiedReference<T, PK>
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | - |
PK | unknown | PrimaryProperty<T> |
Parameters:#
| Name | Type |
|---|---|
entity | T | IdentifiedReference<T, PK> |
Returns: IdentifiedReference<T, PK>
Defined in: packages/core/src/entity/Reference.ts:30
isReference#
â–¸ StaticisReference<T>(data: any): data is Reference<T>
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>
Defined in: packages/core/src/entity/Reference.ts:41
unwrapReference#
â–¸ StaticunwrapReference<T>(ref: T | Reference<T>): T
Returns wrapped entity.
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
ref | T | Reference<T> |
Returns: T
Defined in: packages/core/src/entity/Reference.ts:59
wrapReference#
â–¸ StaticwrapReference<T>(entity: T | Reference<T>, prop: EntityProperty<T>): T | Reference<T>
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: T | Reference<T>
Defined in: packages/core/src/entity/Reference.ts:48