-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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(docs): Added migration and API docs for V4 #16
Conversation
MIGRATION.md
Outdated
|
||
@NgModule({ | ||
imports: [ | ||
StoreModule.provideStore(reducers), |
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 should be forRoot
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.
Fixed
docs/effects/api.md
Outdated
``` | ||
|
||
|
||
### Terminating Effects |
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.
IMO, "Terminating Effects" sounds like a way to kill an effect from running completely rather than meaning it won't automatically dispatch to the store. Maybe my terminology is just incorrect though. If not, "Preventing automatic dispatch" would be one suggestion.
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.
Agreed. I didn't want to call them "dead end" effects either. Maybe "Non-dispatching Effects"?
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.
That sounds good to me!
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.
Got it. Thanks!
docs/store/api.md
Outdated
## Feature Module State Composition | ||
|
||
Store uses fractal state management, which provides state composition through feature modules, | ||
loaded eagerly or lazily. Feature states are added using the `StoreFeature.forFeature` method. This |
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.
should be StoreModule.forFeature
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.
Fixed
d6eb4ec
to
1990ffc
Compare
1990ffc
to
1cb5541
Compare
No description provided.