[![NPM version][npm-image]][npm-url]
[![Open issues][issues-image]][issues-url]
[![Downloads][downloads-image]][downloads-url]
## Description
The [MikroORM](https://b4nan.github.io/mikro-orm) module for [Nest](https://github.com/nestjs/nest).
## Installation
```bash
$ npm i --save mikro-orm nestjs-mikro-orm
```
## Quick Start
Once the installation process is completed, we can import the `MikroOrmModule` into the root `ApplicationModule`.
```typescript
@Module({
imports: [
MikroOrmModule.forRoot({
entitiesDirs: ['../dist/entities'],
entitiesDirsTs: ['../src/entities'],
dbName: 'my-db-name.sqlite3',
type: 'sqlite',
baseDir: __dirname,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}
```
The `forRoot()` method accepts the same configuration object as `init()` from the MikroORM package.
Afterward, the `EntityManager` will be available to inject across entire project (without importing any module elsewhere).
To define which repositories shall be registered in the current scope you can use the `forFeature()` method. For example, in this way:
```typescript
// photo.module.ts
@Module({
imports: [MikroOrmModule.forFeature({ entities: [Photo] })],
providers: [PhotoService],
controllers: [PhotoController],
})
export class PhotoModule {}
```
and import it into the root `AppModule`:
```typescript
// app.module.ts
@Module({
imports: [MikroOrmModule.forRoot(...), PhotoModule],
})
export class AppModule {}
```
In this way we can inject the `PhotoRepository` to the `PhotoService` using the `@InjectRepository()` decorator:
```typescript
@Injectable()
export class PhotoService {
constructor(
@InjectRepository(Photo)
private readonly photoRepository: EntityRepository>
) {}
...
```
## Testing
The `nestjs-mikro-orm` package exposes `getRepositoryToken()` function that returns prepared token based on a given entity to allow mocking the repository.
```typescript
@Module({
providers: [
PhotoService,
{
provide: getRepositoryToken(Photo),
useValue: mockedRepository,
},
],
})
export class PhotoModule {}
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
[issues-image]: https://img.shields.io/github/issues-raw/dario1985/nestjs-mikro-orm
[issues-url]: "https://github.com/dario1985/nestjs-mikro-orm/issues"
[npm-image]: https://img.shields.io/npm/v/nestjs-mikro-orm.svg?style=flat-square
[npm-url]: https://npmjs.org/package/nestjs-mikro-orm
[downloads-image]: https://img.shields.io/npm/dm/nestjs-mikro-orm.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/nestjs-mikro-orm