Skip to content

Commit da4fefe

Browse files
brandonrobertswesleygrimes
authored andcommitted
docs: add docs for minimal flag to store, effects, and schematics
1 parent cede393 commit da4fefe

File tree

4 files changed

+15
-0
lines changed

4 files changed

+15
-0
lines changed

projects/ngrx.io/content/guide/effects/install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@ If your project is using the Angular CLI 6+ then you can install the Effects to
2323
```sh
2424
ng add @ngrx/effects
2525
```
26+
2627
### Optional `ng add` flags
2728

2829
* path - path to the module that you wish to add the import for the `EffectsModule` to.
2930
* flat - Indicate if a directoy is to be created to hold your effects file
3031
* spec - Specifies if a spec file is generated.
3132
* project - name of the project defined in your `angular.json` to help locating the module to add the `EffectsModule` to.
3233
* module - name of file containing the module that you wish to add the import for the `EffectsModule` to. Can also include the relative path to the file. For example, `src/app/app.module.ts`
34+
* minimal - Only provide minimal setup for the root effects setup. Only registers `EffectsModule.forRoot()` in the provided `module` with an empty array.
3335
* group - Group effects file within `effects` folder
3436

3537
This command will automate the following steps:

projects/ngrx.io/content/guide/schematics/effect.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ When used with the `--module` option, it registers an effect within the `Angular
5858
- Type: `boolean`
5959
- Default: `false`
6060

61+
Only provide minimal setup for the root effects setup. Only registers `EffectsModule.forRoot()` in the provided module with an empty array.
62+
63+
- `--minimal`
64+
- Type: `boolean`
65+
- Default: `false`
66+
6167
Specifies if effect has api success and failure actions wired up.
6268

6369
- `--api`

projects/ngrx.io/content/guide/schematics/store.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ When used with the `--module` option, it registers the state within the `Angular
3838
- Type: `boolean`
3939
- Default: `false`
4040

41+
Only provide minimal setup for the root state management. Only registers `StoreModule.forRoot()` in the provided module with an empty object, and default runtime checks.
42+
43+
- `--minimal`
44+
- Type: `boolean`
45+
- Default: `false`
46+
4147
Provide the folder where the state files will be created.
4248

4349
- `--statePath`

projects/ngrx.io/content/guide/store/install.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ ng add @ngrx/store
2929
* path - path to the module that you wish to add the import for the `StoreModule` to.
3030
* project - name of the project defined in your `angular.json` to help locating the module to add the `StoreModule` to.
3131
* module - name of file containing the module that you wish to add the import for the `StoreModule` to. Can also include the relative path to the file. For example, `src/app/app.module.ts`;
32+
* minimal - flag to only provide minimal setup for the root state management. Only registers `StoreModule.forRoot()` in the provided `module` with an empty object, and default runtime checks.
3233
* statePath - The file path to create the state in. By default, this is `reducers`.
3334
* stateInterface - The type literal of the defined interface for the state. By default, this is `State`.
3435

0 commit comments

Comments
 (0)