LoadedReference <T>

Hierarchy

• Reference<Defined<T>>
  • LoadedReference

Index

Properties

• $

Methods

• get
• getEntity
• getProperty
• isInitialized
• load
• loadOrFail
• loadProperty
• populated
• toJSON
• unwrap

Properties

$

$: Defined<T>

Methods

get

• get(): Defined<T>

• Returns Defined<T>

getEntity

• getEntity(): Defined<T>

• Inherited from Reference.getEntity

  Returns Defined<T>

getProperty

• getProperty<K>(prop: K): Defined<T>[K]

• Inherited from Reference.getProperty

  Type parameters

  • K: string | number | symbol

  Parameters

  • prop: K

  Returns Defined<T>[K]

isInitialized

• isInitialized(): boolean

• Inherited from Reference.isInitialized

  Returns boolean

load

• load<TT, P, F, E>(options?: LoadReferenceOptions<TT, P, F, E>): Promise<null | Loaded<TT, P, F, E>>

• Inherited from Reference.load

  Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity. If the entity is not found in the database (e.g. it was deleted in the meantime, or currently active filters disallow loading of it) the method returns null. Use loadOrFail() if you want an error to be thrown in such a case.

  ---

  Type parameters

  • TT: {}
  • P: string = never
  • F: string = *
  • E: string = never

  Parameters

  • options: LoadReferenceOptions<TT, P, F, E> = {}

  Returns Promise<null | Loaded<TT, P, F, E>>

loadOrFail

• loadOrFail<TT, P, F, E>(options?: LoadReferenceOrFailOptions<TT, P, F, E>): Promise<Loaded<TT, P, F, E>>

• Inherited from Reference.loadOrFail

  Ensures the underlying entity is loaded first (without reloading it if it already is loaded). Returns the entity or throws an error just like em.findOneOrFail() (and respects the same config options).

  ---

  Type parameters

  • TT: {}
  • P: string = never
  • F: string = *
  • E: string = never

  Parameters

  • options: LoadReferenceOrFailOptions<TT, P, F, E> = {}

  Returns Promise<Loaded<TT, P, F, E>>

loadProperty

• loadProperty<TT, P, K>(prop: K, options?: LoadReferenceOrFailOptions<TT, P, *, never>): Promise<Loaded<TT, P>[K]>

• Inherited from Reference.loadProperty

  Type parameters

  • TT: {}
  • P: string = never
  • K: string | number | symbol = keyof TT

  Parameters

  • prop: K

  • optionaloptions: LoadReferenceOrFailOptions<TT, P, *, never>

  Returns Promise<Loaded<TT, P>[K]>

populated

• populated(populated?: boolean): void

• Inherited from Reference.populated

  Parameters

  • optionalpopulated: boolean

  Returns void

toJSON

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

• Inherited from Reference.toJSON

  Parameters

  • rest...args: any[]

  Returns Dictionary

unwrap

• unwrap(): Defined<T>

• Inherited from Reference.unwrap

  Returns Defined<T>