Reference <T>

Hierarchy

• Reference
  • LoadedReference

Index

Constructors

• constructor

Methods

• getEntity
• getProperty
• isInitialized
• load
• loadOrFail
• loadProperty
• populated
• toJSON
• unwrap
• create
• createFromPK
• createNakedFromPK
• isReference
• unwrapReference
• wrapReference

Constructors

constructor

• new Reference<T>(entity: T): Reference<T>

• Type parameters

  • T: object

  Parameters

  • entity: T

  Returns Reference<T>

Methods

getEntity

• getEntity(): T

• Returns T

getProperty

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

• Type parameters

  • K: string | number | symbol

  Parameters

  • prop: K

  Returns T[K]

isInitialized

• isInitialized(): boolean

• Returns boolean

load

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

• 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: object
  • 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>>

• 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: object
  • 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]>

• Type parameters

  • TT: object
  • 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

• Parameters

  • optionalpopulated: boolean

  Returns void

toJSON

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

• Parameters

  • rest...args: any[]

  Returns Dictionary

unwrap

• unwrap(): T

• Returns T

staticcreate

• create<T>(entity: T | (T extends Scalar ? ScalarReference<T> : EntityRef<T>)): T extends Scalar ? ScalarReference<T> : EntityRef<T>

• Type parameters

  • T: object

  Parameters

  • entity: T | (T extends Scalar ? ScalarReference<T> : EntityRef<T>)

  Returns T extends Scalar ? ScalarReference<T> : EntityRef<T>

staticcreateFromPK

• createFromPK<T>(entityType: EntityClass<T>, pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T, options?: { schema?: string }): T extends Scalar ? ScalarReference<T> : EntityRef<T>

• Type parameters

  • T: object

  Parameters

  • entityType: EntityClass<T>

  • pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T

  • optionaloptions: { schema?: string }

  Returns T extends Scalar ? ScalarReference<T> : EntityRef<T>

staticcreateNakedFromPK

• createNakedFromPK<T>(entityType: EntityClass<T>, pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T, options?: { schema?: string }): T

• Type parameters

  • T: object

  Parameters

  • entityType: EntityClass<T>

  • pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T

  • optionaloptions: { schema?: string }

  Returns T

staticisReference

• isReference<T>(data: any): data is Reference<T>

• Checks whether the argument is instance of Reference wrapper.

  ---

  Type parameters

  • T: object

  Parameters

  • data: any

  Returns data is Reference<T>

staticunwrapReference

• unwrapReference<T>(ref: T | Reference<T> | ScalarReference<T> | (T extends Scalar ? ScalarReference<T> : EntityRef<T>)): T

• Returns wrapped entity.

  ---

  Type parameters

  • T: object

  Parameters

  • ref: T | Reference<T> | ScalarReference<T> | (T extends Scalar ? ScalarReference<T> : EntityRef<T>)

  Returns T

staticwrapReference

• wrapReference<T, O>(entity: T | Reference<T>, prop: EntityProperty<O, T>): T | Reference<T>

• Wraps the entity in a Reference wrapper if the property is defined as ref.

  ---

  Type parameters

  • T: object
  • O: object

  Parameters

  • entity: T | Reference<T>

  • prop: EntityProperty<O, T>

  Returns T | Reference<T>