@ngrx/entity

What is @ngrx/entity?

@ngrx/entity is a library for managing collections of entities within an Angular application. It provides a set of methods and utilities to simplify the process of managing entity collections, including CRUD operations, sorting, and filtering.

What are @ngrx/entity's main functionalities?

Entity Adapter

The Entity Adapter is a core feature of @ngrx/entity. It provides methods to manage a collection of entities, including adding, updating, and removing entities.

const adapter = createEntityAdapter<User>();

Selectors

Selectors are used to query the state of the entity collection. @ngrx/entity provides built-in selectors to get all entities, entities as a dictionary, entity IDs, and the total count of entities.

const { selectAll, selectEntities, selectIds, selectTotal } = adapter.getSelectors();

Reducers

Reducers are used to handle actions and update the state. @ngrx/entity provides utility functions to create reducers that can handle adding, updating, and removing entities.

const userReducer = createReducer(initialState, on(addUser, (state, { user }) => adapter.addOne(user, state)));

Other packages similar to @ngrx/entity

redux-toolkit

Redux Toolkit is a package that provides tools to simplify Redux development. It includes utilities for creating slices, which can manage collections of entities similar to @ngrx/entity. However, Redux Toolkit is more general-purpose and can be used with any JavaScript framework, not just Angular.

normalizr

Normalizr is a library for normalizing nested JSON data. It can be used to manage collections of entities by transforming nested data into a flat structure. While it does not provide the same level of integration with state management libraries as @ngrx/entity, it is useful for preparing data to be stored in a state management system.

ngrx-data

NGRX Data is an extension of @ngrx/entity that provides additional features for managing entity collections, including entity services and HTTP data access. It builds on top of @ngrx/entity and provides a higher-level API for common entity operations.

README

@ngrx/entity

The sources for this package are in the main NgRx repo. Please file issues and pull requests against that repo.

License: MIT

Changelog

16.3.0 (2023-10-03)

Bug Fixes

• schematics: make action props plural (#4017) (3a56412)

Features

• data: standalone support for ng add @ngrx/data (#4019) (fdd701e), closes #3935
• eslint-plugin: add avoid-combining-component-store-selectors rule (#4043) (0bff440)
• eslint-plugin: add new avoid-mapping-component-store-selectors rule (#4026) (40477dd), closes #3940
• signals: add patchState function and remove $update method (#4037) (f2514ba)
• signals: add signalState and selectSignal APIs (#4007) (745d91f), closes #3993
• signals: add signalStore and signalStoreFeature (#4049) (0010281), closes #4000
• signals: initial setup (#4002) (b0d63fd), closes #3992
• store: prettify createFeature result (#4014) (f179316)

<a name="16.2.0"></a>