81 lines
1.3 KiB
Markdown
81 lines
1.3 KiB
Markdown
# ngrx
|
|
|
|
Add NgRx support to a module
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
ng generate ngrx ...
|
|
|
|
```
|
|
|
|
## Options
|
|
|
|
### name
|
|
|
|
Type: `string`
|
|
|
|
Name of the NgRx feature (e.g., Products, Users, etc.). Recommended to use plural form for name.
|
|
|
|
### module
|
|
|
|
Type: `string`
|
|
|
|
Path to ngModule; host directory will contain the new '+state' directory (e.g., libs/comments/src/lib/comments-state.module.ts).
|
|
|
|
### directory
|
|
|
|
Default: `+state`
|
|
|
|
Type: `string`
|
|
|
|
Override the name of the folder used to contain/group the NgRx files: contains actions, effects, reducers. selectors. (e.g., +state)
|
|
|
|
### root
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Add StoreModule.forRoot and EffectsModule.forRoot() instead of forFeature (e.g., --root).
|
|
|
|
### facade
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Create a Facade class for the the Feature (e.g., --facade).
|
|
|
|
### onlyAddFiles
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Only add new NgRx files, without changing the module file (e.g., --onlyAddFiles).
|
|
|
|
### onlyEmptyRoot
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Do not generate any files. Only generate StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot).
|
|
|
|
### skipFormat
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Skip formatting files
|
|
|
|
### skipPackageJson
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Do not add NgRx dependencies to package.json (e.g., --skipPackageJson)
|