fix(core): deprecate wrappedReference and IdentifiedReference

Use `Ref` and `ref` instead, the long form aliases will be removed in v6.
mikro-orm · May 5, 2023 · ab79832 · ab79832
1 parent ff00110
commit ab79832
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/packages/core/src/entity/Reference.ts b/packages/core/src/entity/Reference.ts
@@ -17,6 +17,7 @@ import type { LockMode } from '../enums';
 import { helper, wrap } from './wrap';
 import { Utils } from '../utils/Utils';
 
+/** @deprecated use `Ref` instead, `IdentifiedReference` type will be removed in v6 */
 export type IdentifiedReference<T, PK extends keyof T | unknown = PrimaryProperty<T>> = true extends IsUnknown<PK> ? Reference<T> : ({ [K in Cast<PK, keyof T>]: T[K] } & Reference<T>);
 
 export class Reference<T> {

diff --git a/packages/core/src/typings.ts b/packages/core/src/typings.ts
@@ -264,6 +264,7 @@ export interface EntityProperty<T = any> {
   precision?: number;
   scale?: number;
   reference: ReferenceType;
+  /** @deprecated use `ref` instead, `wrappedReference` option will be removed in v6 */
   wrappedReference?: boolean;
   fieldNames: string[];
   fieldNameRaw?: string;