Cleanest way to replace an entity in collection

Question

Entity Adapter supports updating a collection with the "updateOne" method call. However, when the updated values' keys don't exist this leads to a specific entity not being updated. See code example.

However, internally the entity adapter uses Object.assign() which while is nice isn't always what I want. I would like it to basically replace the entity in question.

Moreover, if the object in question has the structure A (see below). Then some arbitrary database operation occurred and returned the updated JSON back the frontend. The reducer would eventually get that information in the form.

const originalValue: MyClass = new MyClass('value 1', 'value 2');
const updatedValueFromServer: MyClass = new MyClass('updated');

Then internally to the entity adapter it looks like 

const updateValue = Object.assign(originalValue, updatedValueFromServer);
// which would result in ...
// { key1: 'updated', key2: 'value 2' }
// while I would like
// { key1: 'updated' }
// Or 
// { key1: 'updated', key2: null }

case ActionTypes.UPDATE_SUCCESS:
            return collectionAdapter.updateOne({
                changes: action.payload.alertSubscription,
                id: action.payload.alertSubscription.uniqueID
            }, {
                ...state,
                isLoading: false,
                error: null
            });

export class MyClass {

    constructor(public key1?: string, public key2?: string) { } 
}

I would like it to simply replace the value in the collection, and not attempt to poorly update by internally calling "Object.assign()". Alternatively, somehow setting the keys in the object to null would be beneficial.

Have you found a solution? – Igor Janković Jul 11 '19 at 11:31 — Igor Janković, Jul 11 '19 at 11:31

score 3 · Answer 1 · answered Jun 15 '20 at 03:38

setOne is the way to go.

setOne(payload, state);

Here is full documentation.

addOne: Add one entity to the collection
addMany: Add multiple entities to the collection
setAll: Replace current collection with provided collection
setOne: Add or Replace one entity in the collection
removeOne: Remove one entity from the collection
removeMany: Remove multiple entities from the collection, by id or by predicate
removeAll: Clear entity collection
updateOne: Update one entity in the collection. Supports partial updates.
updateMany: Update multiple entities in the collection. Supports partial updates.
upsertOne: Add or Update one entity in the collection. Supports partial updates.
upsertMany: Add or Update multiple entities in the collection. Supports partial updates.
map: Update multiple entities in the collection by defining a map function, similar to Array.map

Note that this was added in @ngrx/entity@9.x – Jeff Mercado Oct 13 '20 at 19:23 — Jeff Mercado, Oct 13 '20 at 19:23

score 1 · Answer 2 · answered Jan 30 '19 at 07:24

1

You will have to use the upsertOne or upsertAll method - see NgRx docs

upsertOne: Add or Update one entity in the collection
upsertMany: Add or Update multiple entities in the collection

answered Jan 30 '19 at 07:24

timdeschryver

14,415
1
19
32

4

upsert(or update) does not replace entity, it actually extends entity by replacing existing fields, adding new fields, and leaving old fields – Kornel Dylski Feb 11 '20 at 11:08

Cleanest way to replace an entity in collection

2 Answers2