feat(core): add forceConstructor option to @Entity() decorator

Closes mikro-orm/nestjs#104
mikro-orm · Jan 24, 2023 · c89b4af · c89b4af
1 parent 5e4e126
commit c89b4af
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 18 deletions.
diff --git a/docs/docs/decorators.md b/docs/docs/decorators.md
@@ -12,20 +12,19 @@ title: Decorators
 `@Entity` decorator is used to mark your model classes as entities. Do not use it for 
 abstract base classes.
 
-| Parameter          | Type                     | Optional | Description                                                                     |
-|--------------------|--------------------------|----------|---------------------------------------------------------------------------------|
-| `tableName`        | `string`                 | yes      | Override default collection/table name.                                         |
-| `schema`           | `string`                 | yes      | Sets the schema name                                                            |
-| `collection`       | `string`                 | yes      | Alias for `tableName`.                                                          |
-| `comment`          | `string`                 | yes      | Specify comment to table **(SQL only)**                                         |
-| `customRepository` | `() => EntityRepository` | yes      | Set [custom repository class](repositories.md#custom-repository).               |
-| `discriminatorColumn` |  `string` | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance) |                 
-| `discriminatorMap`   |  `Dictionary<string>` | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance) |     
-| `discriminatorValue` |  `number` &#124; `string` | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance) |
-
-abstract | `boolean`;
-
-readonly | `boolean`;
+| Parameter             | Type                     | Optional | Description                                                                      |
+|-----------------------|--------------------------|----------|----------------------------------------------------------------------------------|
+| `tableName`           | `string`                 | yes      | Override default collection/table name.                                          |
+| `schema`              | `string`                 | yes      | Sets the schema name.                                                            |
+| `collection`          | `string`                 | yes      | Alias for `tableName`.                                                           |
+| `comment`             | `string`                 | yes      | Specify comment to table. **(SQL only)**                                         |
+| `customRepository`    | `() => EntityRepository` | yes      | Set [custom repository class](repositories.md#custom-repository).                |
+| `discriminatorColumn` | `string`                 | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance). |                 
+| `discriminatorMap`    | `Dictionary<string>`     | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance). |     
+| `discriminatorValue`  | `number` &#124; `string` | yes      | For [Single Table Inheritance](inheritance-mapping.md#single-table-inheritance). |
+| `forceConstructor`    | `boolean`                | yes      | Enforce use of constructor when creating managed entity instances                |
+| `abstract`              | `boolean`                | yes      | Marks entity as abstract, such entities are inlined during discovery.            |
+| `readonly`              | `boolean`                | yes      | Disables change tracking - such entities are ignored during flush.               |
 
 
 ```ts

diff --git a/packages/core/src/decorators/Entity.ts b/packages/core/src/decorators/Entity.ts
@@ -24,6 +24,7 @@ export type EntityOptions<T> = {
   discriminatorColumn?: string;
   discriminatorMap?: Dictionary<string>;
   discriminatorValue?: number | string;
+  forceConstructor?: boolean;
   comment?: string;
   abstract?: boolean;
   readonly?: boolean;

diff --git a/tests/issues/GH2406.test.ts b/tests/issues/GH2406.test.ts
@@ -1,7 +1,7 @@
 import { Collection, Entity, IdentifiedReference, ManyToOne, MikroORM, OneToMany, PrimaryKey } from '@mikro-orm/core';
 import { SqliteDriver } from '@mikro-orm/sqlite';
 
-@Entity()
+@Entity({ forceConstructor: true })
 export class Parent {
 
   @PrimaryKey()
@@ -12,7 +12,7 @@ export class Parent {
 
 }
 
-@Entity()
+@Entity({ forceConstructor: true })
 export class Child {
 
   @PrimaryKey()
@@ -31,15 +31,14 @@ describe('GH issue 2406', () => {
     orm = await MikroORM.init({
       entities: [Parent, Child],
       dbName: ':memory:',
-      forceEntityConstructor: true,
       driver: SqliteDriver,
     });
     await orm.schema.createSchema();
   });
 
   afterAll(() => orm.close(true));
 
-  test('should fetch children when forceEntityConstructor is turned on', async () => {
+  test('should fetch children when forceConstructor is turned on', async () => {
     const parent = orm.em.create(Parent, {});
     expect(parent.children.isInitialized()).toBe(true);
     expect(parent.children.isDirty()).toBe(false);