LoadedReference <T>

A Reference<T> that is guaranteed to be loaded, providing synchronous access via $ and get().

Hierarchy

• Reference<NonNullable<T>>
  • LoadedReference

Index

Properties

• $

Methods

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

Properties

$

$: NonNullable<T>

Methods

get

• get(): NonNullable<T>

• Returns NonNullable<T>

inheritedgetEntity

• getEntity(): NonNullable<T>

• Inherited from Reference.getEntity

  Returns the underlying entity, throwing an error if the reference is not initialized.

  ---

  Returns NonNullable<T>

inheritedgetProperty

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

• Inherited from Reference.getProperty

  Returns the value of a property on the underlying entity. Throws if the reference is not initialized.

  ---

  Parameters

  • prop: K

  Returns NonNullable<T>[K]

inheritedisInitialized

• isInitialized(): boolean

• Inherited from Reference.isInitialized

  Returns whether the underlying entity has been fully loaded from the database.

  ---

  Returns boolean

inheritedload

• load<TT, P, F, E>(options): 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.

  ---

  Parameters

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

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

inheritedloadOrFail

• loadOrFail<TT, P, F, E>(options): 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).

  ---

  Parameters

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

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

inheritedloadProperty

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

• Inherited from Reference.loadProperty

  Loads the entity if needed, then returns the value of the specified property.

  ---

  Parameters

  • prop: K

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

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

inheritedpopulated

• populated(populated): void

• Inherited from Reference.populated

  Marks the underlying entity as populated or not for serialization purposes.

  ---

  Parameters

  • optionalpopulated: boolean

  Returns void

inheritedtoJSON

• toJSON(...args): Dictionary

• Inherited from Reference.toJSON

  Serializes the underlying entity to a plain JSON object.

  ---

  Parameters

  • rest...args: any[]

  Returns Dictionary

inheritedunwrap

• unwrap(): NonNullable<T>

• Inherited from Reference.unwrap

  Returns the underlying entity without checking initialization state.

  ---

  Returns NonNullable<T>