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(entity: T): Reference<T>

• Parameters

  • entity: T

  Returns Reference<T>

Methods

getEntity

• getEntity(): T

• Returns T

getProperty

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

• Parameters

  • prop: K

  Returns T[K]

isInitialized

• isInitialized(): boolean

• Returns boolean

load

• load(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.

  ---

  Parameters

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

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

loadOrFail

• loadOrFail(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).

  ---

  Parameters

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

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

loadProperty

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

• 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(entity: T | Ref<T>): Ref<T>

• Parameters

  • entity: T | Ref<T>

  Returns Ref<T>

staticcreateFromPK

• createFromPK(entityType: EntityClass<T>, pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<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 }): Ref<T>

• Parameters

  • entityType: EntityClass<T>

  • pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<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 }

  • optionalschema: string

  Returns Ref<T>

staticcreateNakedFromPK

• createNakedFromPK(entityType: EntityClass<T>, pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<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

• Parameters

  • entityType: EntityClass<T>

  • pk: T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<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 }

  • optionalschema: string

  Returns T

staticisReference

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

• Checks whether the argument is instance of Reference wrapper.

  ---

  Parameters

  • data: any

  Returns data is Reference<T>

staticunwrapReference

• unwrapReference(ref: T | Reference<T> | ScalarReference<T> | Ref<T>): T

• Returns wrapped entity.

  ---

  Parameters

  • ref: T | Reference<T> | ScalarReference<T> | Ref<T>

  Returns T

staticwrapReference

• wrapReference(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.

  ---

  Parameters

  • entity: T | Reference<T>

  • prop: EntityProperty<O, T>

  Returns T | Reference<T>