Reference <T>
Hierarchy
- Reference
Index
Constructors
constructor
Type parameters
- T
Parameters
entity: T
Returns Reference<T>
Methods
[custom]
Parameters
depth: number
Returns string
getEntity
Returns T
getProperty
Type parameters
- K: string | number | symbol
Parameters
prop: K
Returns T[K]
isInitialized
Returns boolean
load
Type parameters
- K: string | number | symbol = never
- P: string = never
Parameters
optionaloptions: LoadReferenceOptions<T, P>
Returns Promise<T>
populated
Parameters
optionalpopulated: boolean
Returns void
set
Parameters
entity: T | IdentifiedReference<T, PrimaryProperty<T>>
Returns void
toJSON
Parameters
rest...args: any[]
Returns Dictionary
unwrap
Returns T
staticcreate
Type parameters
- T: object
- PK: unknown = PrimaryProperty<T>
Parameters
entity: T | IdentifiedReference<T, PK>
Returns IdentifiedReference<T, PK>
staticcreateFromPK
Type parameters
- T: object
- PK: unknown = PrimaryProperty<T>
Parameters
entityType: EntityClass<T>
pk: Primary<T>
optionaloptions: { schema?: string }
Returns IdentifiedReference<T, PK>
staticcreateNakedFromPK
Type parameters
- T: object
- PK: unknown = PrimaryProperty<T>
Parameters
entityType: EntityClass<T>
pk: Primary<T>
optionaloptions: { schema?: string }
Returns T
staticisReference
Checks whether the argument is instance of
Reference
wrapper.Type parameters
- T: object
Parameters
data: any
Returns data is Reference<T>
staticunwrapReference
Returns wrapped entity.
Type parameters
- T: object
Parameters
ref: T | Reference<T>
Returns T
staticwrapReference
Wraps the entity in a
Reference
wrapper if the property is defined aswrappedReference
.Type parameters
- T: object
Parameters
entity: T | Reference<T>
prop: EntityProperty<T>
Returns T | Reference<T>
Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity.