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

Aligned MongooseModuleOptions with MongooseModuleAsyncOptions #245

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

BorntraegerMarc
Copy link
Contributor

@BorntraegerMarc BorntraegerMarc commented Jan 26, 2020

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[X] Other... Please describe: Refactoring with API changes

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?

[X] Yes
[ ] No

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

@BorntraegerMarc
Copy link
Contributor Author

BorntraegerMarc commented Jan 26, 2020

Docs have been added / updated (for bug fixes / features)

Where should I adapt the docs?

Also I was wondering if we should create a v7 branch or a next branch for changes that will be released in the next major version?

uri: string,
options: MongooseModuleOptions = {},
): DynamicModule {
static forRoot(options: MongooseModuleOptions): DynamicModule {
Copy link

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?

Copy link
Contributor Author

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)...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants