ngrx
Adds NgRx support to an application or library.
Usage
nx generate ngrx ...By default, Nx will search for
ngrx in the default collection provisioned in workspace.json.You can specify the collection explicitly as follows:
nx g @nrwl/angular:ngrx ...Show what will be generated without writing to disk:
nx g ngrx ... --dry-runOptions
module (required)
Type:
stringThe path to the
NgModule where the feature state will be registered. The host directory will create/use the new state directory.name (required)
Type:
stringName of the NgRx feature state, such as
products or users. Recommended to use the plural form of the name.barrels
Default:
falseType:
booleanUse barrels to re-export actions, state and selectors.
directory
Default:
+stateType:
stringThe name of the folder used to contain/group the generated NgRx files.
facade
Default:
falseType:
booleanCreate a Facade class for the the feature.
minimal
Default:
trueType:
booleanOnly register the root state management setup or feature state.
onlyAddFiles
Default:
falseType:
booleanDeprecated: Use the
skipImport option instead.Only add new NgRx files, without changing the module file (e.g.,
--onlyAddFiles).onlyEmptyRoot
Default:
falseType:
booleanDeprecated: Use the
minimal option instead.Do not generate any files. Only generate
StoreModule.forRoot and EffectsModule.forRoot (e.g., --onlyEmptyRoot).root
Default:
falseType:
booleanSetup root or feature state management with NgRx.
skipFormat
Default:
falseType:
booleanSkip formatting files.
skipImport
Default:
falseType:
booleanGenerate NgRx feature files without registering the feature in the NgModule.
skipPackageJson
Default:
falseType:
booleanDo not update the
package.json with NgRx dependencies.syntax
Default:
creatorsType:
stringPossible values:
classes, creatorsSpecifies whether to use class-based or creator functions for actions, reducers, and effects.
useDataPersistence
Default:
falseType:
booleanGenerate NgRx Effects with the
DataPersistence helper service. Set to false to use plain effects data persistence operators.