LoadedReference <T>

Hierarchy

• Reference<Defined<T>>
  • LoadedReference

Index

Properties

• $

Methods

• [custom]
• get
• getEntity
• getProperty
• isInitialized
• load
• populated
• set
• toJSON
• unwrap

Properties

$

$: Exclude<T, undefined | null>

Methods

[custom]

• [custom](depth: number): string

• Inherited from Reference.[custom]

  Parameters

  • depth: number

  Returns string

get

• get(): Exclude<T, undefined | null>

• Returns Exclude<T, undefined | null>

getEntity

• getEntity(): Exclude<T, undefined | null>

• Inherited from Reference.getEntity

  Returns Exclude<T, undefined | null>

getProperty

• getProperty<K>(prop: K): Exclude<T, undefined | null>[K]

• Inherited from Reference.getProperty

  Type parameters

  • K: string | number | symbol

  Parameters

  • prop: K

  Returns Exclude<T, undefined | null>[K]

isInitialized

• isInitialized(): boolean

• Inherited from Reference.isInitialized

  Returns boolean

load

• load<K, P>(options?: LoadReferenceOptions<Exclude<T, undefined | null>, P>): Promise<Exclude<T, undefined | null>>
• load<K>(prop: K): Promise<Exclude<T, undefined | null>[K]>

• Inherited from Reference.load

  Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity.

  ---

  Type parameters

  • K: string | number | symbol = never
  • P: string = never

  Parameters

  • optionaloptions: LoadReferenceOptions<Exclude<T, undefined | null>, P>

  Returns Promise<Exclude<T, undefined | null>>

populated

• populated(populated?: boolean): void

• Inherited from Reference.populated

  Parameters

  • optionalpopulated: boolean

  Returns void

set

• set(entity: Exclude<T, undefined | null> | IdentifiedReference<Exclude<T, undefined | null>, PrimaryProperty<Exclude<T, undefined | null>>>): void

• Inherited from Reference.set

  Parameters

  • entity: Exclude<T, undefined | null> | IdentifiedReference<Exclude<T, undefined | null>, PrimaryProperty<Exclude<T, undefined | null>>>

  Returns void

toJSON

• toJSON(...args: any[]): Dictionary

• Inherited from Reference.toJSON

  Parameters

  • rest...args: any[]

  Returns Dictionary

unwrap

• unwrap(): Exclude<T, undefined | null>

• Inherited from Reference.unwrap

  Returns Exclude<T, undefined | null>