effect.md

Effect

---

Overview

Generates an effect file for @ngrx/effects.

Command

ng generate effect EffectName [options]

OR

ng generate ef EffectName [options]

Options

Nest the effects file within a folder based by the effect name.

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

Group the effect file within an effects folder.

• --group
  • Alias: -g
  • Type: boolean
  • Default: false

Provide the path to a file containing an Angular Module and the effect will be added to its imports array. If the --root option is not included, the effect will be registered using EffectsModule.forFeature.

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

When used with the --module option, it registers an effect within the Angular Module using EffectsModule.forRoot.

• --root
  • Type: boolean
  • Default: false

Generate a spec file alongside the action file.

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

Examples

Generate a UserEffects file and register it within the root Angular module in the root-level effects.

ng generate effect User --root -m app.module.ts

Generate a UserEffects file within a user folder and register it with the user.module.ts file in the same folder.

ng generate module User --flat false
ng generate effect user/User -m user.module.ts

Generate a UserEffects file within a nested effects folder

ng generate effect User --group