-
Notifications
You must be signed in to change notification settings - Fork 119
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
Aligned MongooseModuleOptions with MongooseModuleAsyncOptions #245
base: master
Are you sure you want to change the base?
Conversation
Fixes nestjs#244 BREAKING CHANGE: Removed URI param in MongooseCoreModule.forRoot and made it non-optional in option object
Where should I adapt the docs? Also I was wondering if we should create a |
uri: string, | ||
options: MongooseModuleOptions = {}, | ||
): DynamicModule { | ||
static forRoot(options: MongooseModuleOptions): DynamicModule { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change, could we support both cases in this module and add a deprecation warning?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could, technically. Yes.
Although I'm more in favour to add a single breaking change & document it properly. Adaptation for consumers for this breaking change should be simple enough.
But either way: I'm not really willing to invest more time into this PR and make further changes, since it seems like to me that this PR will not get merged (open for more than 1 year)...
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Options aren't really aligned and don't make sense.
Issue Number: #244
What is the new behavior?
See linked issue for description.
Does this PR introduce a breaking change?
Applications will need to move from this:
MongooseCoreModule.forRoot('mongooseUri', {})
to this ->MongooseCoreModule.forRoot({uri: 'mongooseUri'})
Should be an easy migration
Other information
I'll create a squash & merge so we have 1 clean commit msg