Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@briebug/ngrx-auto-entity

Package Overview
Dependencies
Maintainers
5
Versions
69
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@briebug/ngrx-auto-entity

An automatic entity action library for NgRX

  • 0.0.13
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
442
increased by10.22%
Maintainers
5
Weekly downloads
 
Created
Source

CircleCI

This project was generated with Angular CLI version 6.0.8.

NgRX Auto-Entity

Automatic entities for @ngrx! With this library, you can take the weight off your plate, and get back to business!

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 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 6 and NgRX 6, 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.

Full Usage Documentation

If you wish to learn more about how Auto-Entity works, you may jump to the full usage documentation.

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
  • Extended effects for loading indicator display, toasts or snackbars, etc.
  • Filtering of entities meta reducer handles
  • Filtering of entities effects handle

Contributors

Keywords

FAQs

Package last updated on 04 Nov 2018

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc