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

feat: support extending type for mongoose.models #10806

Merged
merged 1 commit into from
Oct 8, 2021

Conversation

MunifTanjim
Copy link
Contributor

@MunifTanjim MunifTanjim commented Sep 29, 2021

Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory.

If you're making a change to documentation, do not modify a .html file directly. Instead find the corresponding .pug file or test case in the test/docs directory.

Summary

Currently mongoose.models can not be explictly typed. So, mongoose.models.Cat will always have the type Model<any>.

This change enables users to explicitly type mongoose.models.

Examples

Create a file mongoose.d.ts in your codebase:

declare module 'mongoose' {
  interface Models {
    Cat: CatModel; // CatModel is something like `interface CatModel extends Model<CatDocument>`
  }
}

Now the type for mongoose.models.Cat will be CatModel, type for mongoose.models.Fish will be Model<any>

Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vkarpov15 vkarpov15 added this to the 6.0.10 milestone Oct 8, 2021
@vkarpov15 vkarpov15 added the typescript Types or Types-test related issue / Pull Request label Oct 8, 2021
@vkarpov15 vkarpov15 merged commit f312fd1 into Automattic:master Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typescript Types or Types-test related issue / Pull Request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants