@mikro-orm/decorators

Decorator definitions for MikroORM entity mapping. Provides both legacy (TypeScript experimental) and ES spec decorator definitions for defining entities, properties, and relations.

Installation

npm install @mikro-orm/core @mikro-orm/decorators

Note: @mikro-orm/core re-exports all decorators, so you only need to install this package directly if you want to use decorators without pulling in the full core module.

Usage

import { Entity, PrimaryKey, Property, ManyToOne } from '@mikro-orm/core';

@Entity()
class Book {
  @PrimaryKey()
  id!: number;

  @Property()
  title!: string;

  @ManyToOne(() => Author)
  author!: Author;
}

ES Spec Decorators

For projects using the TC39 standard decorators (TypeScript 5.0+):

import { Entity, PrimaryKey, Property } from '@mikro-orm/decorators';

Legacy Decorators

For projects using TypeScript experimental decorators:

import { Entity, PrimaryKey, Property } from '@mikro-orm/decorators/legacy';

Available Decorators

• Entity: @Entity() — marks a class as a persistent entity
• Properties: @Property(), @Enum(), @Formula(), @Index(), @Unique(), @Check()
• Primary keys: @PrimaryKey(), @SerializedPrimaryKey()
• Relations: @ManyToOne(), @OneToMany(), @ManyToMany(), @OneToOne()
• Embeddables: @Embeddable(), @Embedded()
• Lifecycle hooks: @BeforeCreate(), @AfterCreate(), @BeforeUpdate(), @AfterUpdate(), @BeforeDelete(), @AfterDelete()

Documentation

See the official MikroORM documentation and the using decorators guide.

License

Copyright © 2018-present Martin Adámek. Licensed under the MIT License.