@briebug/ngrx-auto-entity
Advanced tools
Automatic Entity State and Facades for NgRx. Simplifying reactive state!
Automatic entities for @ngrx! Simplifying reactive state!
BETA: ANGULAR 13 & 14 support is in testing! You may install the beta tags of NgRx Auto-Entity v14.x to try out the library with the latest versions of Angular. In preliminary testing we have noticed no issues as of yet, however that does not mean there are none. In particular, we suspect that RxJs 7 may be an area that could potentially encounter issues. Use with caution for now, and please open issues on the Auto-Entity GitHib repo if you encounter any.
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 v12 currently supports Angular 9-12, and the corresponding NgRx versions. Base version support is as follows:
NgRx Auto-Entity v13 & v14 is currently in beta release. While preliminary testing does not indicate any notable issues, we do not yet recommend this version of NgRx Auto-Entity for critical production releases. Testing and developmental releases may rely on NgRx Auto-Entity 14, with support for Angular & NgRx 13 and 14.
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!)
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.
