JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2865
  • Score
    100M100P100Q132892F

Automatic Entity State and Facades for NgRx. Simplifying reactive state!

Package Exports

  • @briebug/ngrx-auto-entity

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@briebug/ngrx-auto-entity) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CircleCI

This project was generated with Angular CLI version 6.0.8.

NgRX Auto-Entity

Automatic entities for @ngrx! Simplifying reactive state!

NOTE: NgRX Auto-Entity is currently a beta library. It is in flux as we continue to refine and enhance it's functionality, identify and eliminate bugs, optimize it's performance. If you find any errors in this documentation, or bugs within the library, please let us know!

What is it?

NgRX Auto-Entity aims to provide a seamless means of dealing with standard entity actions and effects with minimal repetitive code requirements, while preserving the fundamental nature of NgRX itself. This library is not a replacement for or alternative to NgRX. It works within the standard paradigm that NgRX has set forth, making use of actions, reducers & effects like any other NgRX application.

What Auto-Entity does do is provide a set of ready-made, generic actions for handling all of the standard CRUD operations for entities, so you neither have to write nor generate any of that code yourself. Auto-Entity generates pre-fabricated facades around NgRx and the store/state, providing a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible framework that you may use in its entirety for all of your entity needs, or use piecemeal as necessary in order to achieve your specific goals.

While it is not required and Auto-Entity is an entirely independent library that solely depends on Angular and NgRX, Auto-Entity manages state in a manner that is compatible with @ngrx/entity as well, in the event you wish to utilize some of the utilities from that library in your own custom reducers.

Installation

Install @briebug/ngrx-auto-entity from npm:

npm install @briebug/ngrx-auto-entity or yarn add @briebug/ngrx-auto-entity

If you have not already, install the required peer dependencies as well:

npm install @ngrx/{effects,store,store-devtools} ngrx-store-freeze or yarn add @ngrx/{effects,store,store-devtools} ngrx-store-freeze

Quick Start

If you want to get rolling as quickly and simply as possible, you may jump to the quick start guide. (Note: Documentation still in progress!)

Full Usage Documentation

If you wish to learn more about how Auto-Entity works, you may jump to the full usage documentation. (Note: Documentation still in progress!)

Roadmap

  • Initial design of automatic actions
  • Automatic service mapping & lookup
  • Custom criteria
  • Default effects
  • Composite keys
  • Get entity key support on entities
  • Built-in loading indicator tracking
  • Built-in saving indicator tracking
  • Built-in deleting indicator tracking
  • Built-in entity selection support
  • Pre-fabricated facade generation
  • Generated stub reducers
  • Enhanced IEntityInfo interface with naming utilities
  • Extended effects for loading indicator display, toasts or snackbars, etc.
  • Filtering of entities meta reducer handles
  • Filtering of entities effects handle

Contributors