entity.md

Entity

---

Overview

Generates a set of entity files for managing a collection using @ngrx/entity including a set of predefined actions, a collection model and a reducer with state selectors.

Command

ng generate entity EntityName [options]

OR

ng generate en EntityName [options]

Options

Nest the effects file within a folder based on the entity name.

• --flat
  • Type: boolean
  • Default: true

Provide the path to a file containing an Angular Module and the entity reducer will be added to its imports array using StoreModule.forFeature.

• --module
  • Alias: -m
  • Type: string

Provide the path to a reducers file containing a state interface and a object map of action reducers. The generated entity interface will be imported and added to the first defined interface within the file. The entity reducer will be imported and added to the first defined object with an ActionReducerMap type.

• --reducers
  • Alias: -r
  • Type: string

Generate spec files associated with the entity files.

• --spec
  • Type: boolean
  • Default: true

Examples

Generate a set of User entity files and add it to a defined map of reducers generated from a feature state.

ng generate entity User --reducers reducers/index.ts

Generate a set of User entity files within a nested folder.

ng generate entity User --flat false

Generate a set of User entity files and register it within the Angular Module in app.module.ts as a feature state.

ng generate entity User -m app.module.ts