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

refactor(RouterStore): change default state key to router #1258

Merged
merged 2 commits into from
Aug 22, 2018

Conversation

timdeschryver
Copy link
Member

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)
[x] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #1241

What is the new behavior?

Does this PR introduce a breaking change?

[x] Yes
[ ] No

Other information

Closes #1241

BREAKING CHANGE:

The default state key is changed from routerReducer to router

@coveralls
Copy link

coveralls commented Aug 18, 2018

Coverage Status

Coverage remained the same at 88.615% when pulling 3b12eb6 on timdeschryver:pr/router-state-key into 2268fc4 on ngrx:master.

Copy link
Member

@brandonroberts brandonroberts left a comment

Choose a reason for hiding this comment

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

The docs and example app need updating also

BREAKING CHANGE:

The default state key is changed from routerReducer to router
@timdeschryver timdeschryver force-pushed the pr/router-state-key branch 2 times, most recently from e214dfe to c1f0815 Compare August 22, 2018 11:08
@@ -1,5 +1,18 @@
# API

## StoreRouterConnectingModule.forRoot
Copy link
Member

Choose a reason for hiding this comment

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

Change to Configuration Options

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@@ -1,5 +1,18 @@
# API

## StoreRouterConnectingModule.forRoot

To connect the Angular router module with the NgRx store module, import the store module via
Copy link
Member

Choose a reason for hiding this comment

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

Remove the function that accepts an object. Its going to be removed from the API

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.


To connect the Angular router module with the NgRx store module, import the store module via
`StoreRouterConnectingModule.forRoot()`.

Copy link
Member

Choose a reason for hiding this comment

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

What happened to the description for stateKey?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm confused 😅
Like this you mean?

Copy link
Member

Choose a reason for hiding this comment

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

😴 I must have been looking at a partial change. 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

No, I've recommitted. I must have done something wrong...

@brandonroberts brandonroberts merged commit e8173d9 into ngrx:master Aug 22, 2018
@timdeschryver timdeschryver deleted the pr/router-state-key branch August 22, 2018 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change default stateKey for router-store to "router"
3 participants