@briebug/ngrx-auto-entity
Advanced tools
Automatic Entity State and Facades for NgRx. Simplifying reactive state!
Automatic entities for @ngrx! Simplifying reactive state!
Announcing: ANGULAR 12 is now supported! NgRx Auto-Entity has been updated to support the latest versions of Angular, as well as NgRx through version 12. With this update, we have also dropped support for Angular 8, meaning the supported versions of angular are 9-12.
NOTE: Angular 13 support is being researched. Starting with Ng 13, all View Engine support will be dropped from the platform completely. One of our goals with Auto-Entity has been to support older versions of angular as long as possible, given the often slower upgrade times for many companies. With Ng 13 putting the burden on library developers to support Ivy, that forces groups like ourselves to build our library to target specific instruction sets. That will increase the challenge of supporting older versions of Angular. As such, we are actively looking for ways to deal with that scenario, and hope to be prepared when the time comes.
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!
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 actions, selectors, effects & a core metareducer for handling all of the standard CRUD functionality for entities, so you neither have to write nor generate any of that code yourself. Auto-Entity supports implementing applications with recommended best practices, including good action hygiene. Auto-Entity also generates pre-fabricated facades around NgRx and the store/state, providing a cohesive, logical and simplified API into your state for those who prefer facades. 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.
NgRx Auto-Entity currently depends on Angular 9+, NgRx 9+ and RxJs 6.
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} or yarn add @ngrx/{effects,store,store-devtools}
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!)
If you wish to learn more about how Auto-Entity works, you may jump to the full usage documentation. (Note: Documentation still in progress!)
0.7.0 Beta (2021-08-02)
This release officially adds support for Angular 12 and NgRx 12! With the advent of Ivy, and its
continued progress towards replacing View Engine, supporting Angular 12 required a bit more active
work to support. Currently, the library is built with enableIvy set to false, which allows the
library to be built with support for View Engine versions of Angular.
Research and planning has begun on supporting Angular 13, however this will be a more challenging task than supporting Angular 12 due to the fact that View Engine will be dropped entirely from Ng 13, which will affect our ability to build a library that supports older versions of Angular. We hope to have a plan in place for this scenario soon.
This release also updates some internal usage of NgRx to drop use of legacy or fully deprecated
features, such as the @Entity decorator.
@Effect() decorator, and are now using
the current and recommended createEffect() function. This is to ensure support with NgRx 12+.<a name="0.6.1"></a>
FAQs
Automatic Entity State and Facades for NgRx. Simplifying reactive state!
The npm package @briebug/ngrx-auto-entity receives a total of 313 weekly downloads. As such, @briebug/ngrx-auto-entity popularity was classified as not popular.
We found that @briebug/ngrx-auto-entity demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.