Function ref

packages/core/src/entity/Reference.ts:424–449

(
  entityOrType?: T | Ref<T> | EntityClass<T> | null,
  pk?: T | PKV | null,
)

 * shortcut for `wrap(entity).toReference()`
 */
export function ref<T, PKV extends Primary<T> = Primary<T>>(
  entityOrType?: T | Ref<T> | EntityClass<T> | null,
  pk?: T | PKV | null,
): Ref<T> | undefined | null {
  if (entityOrType == null) {
    return entityOrType as unknown as null;
  }

  if (Utils.isEntity(entityOrType, true)) {
    return helper(entityOrType).toReference() as Ref<T>;
  }

  if (Utils.isEntity(pk, true)) {
    return helper(pk).toReference() as Ref<T>;
  }

  if (arguments.length === 1) {
    return new ScalarReference<T>(entityOrType, true) as Ref<T>;
  }

  if (pk == null) {
    return pk as null;
  }

  return Reference.createFromPK(entityOrType as EntityClass<T>, pk as PKV) as Ref<T>;
}

/**
 * Unwraps a reference to its underlying value, returning the entity or scalar. Works on any of: