🚀[FEATURE]: Operator to remove an object key/property

[enekonieto]

Relevant Package

@ngxs/store

Description

New operator to remove a key/property from an object in state model.

Describe the problem you are trying to solve

We use entity tables in state models to get data normalized, as suggested by docs.

export interface EntityTableData<E extends EntityType> {
  byId: EntityMap<E>
  allIds: EntityIdType[]
}

export type EntityMap<E> = {
  [entityId: EntityIdType]: E;
}

We have no problem inserting and updating entities from tables with patch and append operators, but we miss and operator to delete keys from EntityTableData.byId so we can remove objects from table.

Describe the solution you'd like

We would like an operator able to delete keys from an object, so we can use like this:

 export function removeEntity<E extends EntityType>(entity: EntityType): StateOperator<EntityTableData<E>> {
  return patch({
    byId: removeKey(entity.entityId),
    allIds: removeItem<EntityIdType>((entityId) => entityId === entity.entityId)
  })
}

Describe alternatives you've considered

Destructuring object to extract key we want to remove and patching state with new byId object:

const {[entity.entityId]: _, ...newById} = ctx.getState().example.byId;
// Patch state using 'byId: newById'