Skip to content

Commit

Permalink
docs(Effects): Clarify difference between forRoot and forFeature (#92)
Browse files Browse the repository at this point in the history
Adding effects via `forRoot()` and `forFeature()` is functionally identical. This PR makes that clearer in the docs.
  • Loading branch information
karptonite authored and MikeRyanDev committed Jul 18, 2017
1 parent 33c1722 commit 2737402
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/effects/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class AppModule { }
### forFeature
Registers @ngrx/effects services to run with your feature modules.

**Note**: Running an effects class multiple times (for example via different lazy loaded modules) will not cause Effects to run multiple times.
**Note**: Running an effects class multiple times, either by `forRoot()` or `forFeature()`, (for example via different lazy loaded modules) will not cause Effects to run multiple times. There is no functional difference between effects loaded by `forRoot()` and `forFeature()`; the important difference between the functions is that `forRoot()` sets up the providers required for effects.

Usage:
```ts
Expand Down

0 comments on commit 2737402

Please sign in to comment.