ScalarReference <Value>

Index

Constructors

• constructor

Methods

• bind
• isInitialized
• load
• set
• unwrap

Constructors

constructor

• new ScalarReference<Value>(value?: Value, initialized?: boolean): ScalarReference<Value>

• Type parameters

  • Value

  Parameters

  • optionalvalue: Value

  • initialized: boolean = ...

  Returns ScalarReference<Value>

Methods

bind

• bind<Entity>(entity: Entity, property: EntityKey<Entity>): void

• Type parameters

  • Entity: object

  Parameters

  • entity: Entity

  • property: EntityKey<Entity>

  Returns void

isInitialized

• isInitialized(): boolean

• Returns boolean

load

• load(options?: Omit<LoadReferenceOptions<any, any, *, never>, populate | fields | exclude>): Promise<undefined | Value>

• Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns either the whole entity, or the requested property.

  ---

  Parameters

  • optionaloptions: Omit<LoadReferenceOptions<any, any, *, never>, populate | fields | exclude>

  Returns Promise<undefined | Value>

set

• set(value: Value): void

• Parameters

  • value: Value

  Returns void

unwrap

• unwrap(): undefined | Value

• Returns undefined | Value