Skip to content

Angular Suite Module state management

This document aims to provide guidelines as how to structure your state slices, actions, reducers and etc, as well as provide answers to some frequently asked questions. It draws inspiration from recommendations made by the NGRX Team, Good Action Hygiene, the Redux Style Guide and some in house recommendations from the Suite Team.

Notice

This section is under construction

Resources

  1. Redux style guide: Yes, we are not using pure redux, but some if not most of the best practices defined by the Redux community will apply to any redux-based solution.
  2. Good Action Hygiene
  3. Ngrx: Patterns and techniques

Wiki NGRX section

  1. Runtime checks must be enabled. strictActionImmutability, strictStateImmutability, strictStateSerializability, strictActionSerializability
  2. Action types must contain application namespace in PascalCase (i.e: 'iinspector/Create inspection', 'Core/Token obtained')
  3. Action types must be sentence case (i.e: "iinspector/Create inspections continues in lowercase")
  4. Feature Keys must be lowercase, app prefixed and pascalCase. (i.e: 'coreAuth', 'iinspectorTemplate')

Actions

  1. Actions should be unique in the source/event they are describing.
  2. Actions have a unique dispatch point, and are not reused.
  3. Actions should live close to the place they are dispatched from.
  4. Actions should capture events, not commands nor represent functions.