Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation incorrect #5

Open
collabcoding614 opened this issue Feb 26, 2020 · 3 comments
Open

Documentation incorrect #5

collabcoding614 opened this issue Feb 26, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@collabcoding614
Copy link

https://mikro-orm.io/docs/usage-with-nestjs

The adapter forFeature is incorrectly documented.
The documentation shows

@Module({
  imports: [MikroOrmModule.forFeature([Photo])],
  providers: [PhotoService],
  controllers: [PhotoController],
})
export class PhotoModule {}

When it should be

@Module({
  imports: [MikroOrmModule.forFeature([{entities: Photo}])],
  providers: [PhotoService],
  controllers: [PhotoController],
})
export class PhotoModule {}
@dariomncs
Copy link
Owner

thank you for reporting! I already fixed it in the 6536d4d

+@B4nan to report the error in the website too.

@dariomncs dariomncs added the documentation Improvements or additions to documentation label Mar 2, 2020
@dariomncs dariomncs self-assigned this Mar 2, 2020
@B4nan
Copy link
Collaborator

B4nan commented Mar 2, 2020

What about supporting that array param? Currently there is no other option as the entities array, right? I would support both (to maintain BC).

@dariomncs
Copy link
Owner

Ok! I don't think I ever supported that, I think It was an error in the README.md but I can add support for both formats easily.

@dariomncs dariomncs reopened this Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants