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(docs): Added migration and API docs for V4 #16

Merged
merged 5 commits into from
Apr 27, 2017
Merged

Conversation

brandonroberts
Copy link
Member

No description provided.

MIGRATION.md Outdated

@NgModule({
imports: [
StoreModule.provideStore(reducers),

Choose a reason for hiding this comment

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

this should be forRoot

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

```


### Terminating Effects
Copy link

@Matmo10 Matmo10 Apr 25, 2017

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.

Copy link
Member Author

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"?

Copy link

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!

Copy link
Member Author

Choose a reason for hiding this comment

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

Got it. Thanks!

## 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

Choose a reason for hiding this comment

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

should be StoreModule.forFeature

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.791% when pulling 1990ffc on migration-docs into 5d0ecf9 on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.791% when pulling 1cb5541 on migration-docs into 5d0ecf9 on master.

@brandonroberts brandonroberts changed the title WIP feat(docs): Added migration and API docs for V4 feat(docs): Added migration and API docs for V4 Apr 27, 2017
@MikeRyanDev MikeRyanDev merged commit 406161b into master Apr 27, 2017
@MikeRyanDev MikeRyanDev deleted the migration-docs branch April 27, 2017 01:41
@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.791% when pulling 28e9abb on migration-docs into 5d0ecf9 on master.

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.

None yet

7 participants