README.md

Component Store

Inspired (semi-forked) of https://github.com/amcdnl/ngrx-actions

The mission of this (another more... 😆) store is to maintain the state of a component (not the wide app).

I have been searching for one and I didn't find any... then, I created it 😅

Dependencies

This module depends on immer

How to install?

npm i immer @qontu/component-store or yarn add immer @qontu/component-store

How to use?

You can see an example here

Why do I need to install immer?

Because it's a powerful inmutable state tree, it allow us to do:

interface UserListState {
  users: User[],
  usersMap: Record<number, User>,
}


@Store<UserListState>({
  users: [],
  usersMap: {},
})
export class UserListStore {

  @Action(Update)
  updateUsingImmer(state: UserListState, { user  }: Update) {
    const userToUpdate = state.users.find(({ id }) => id === user.id);
    Object.assign(userToUpdate, user);
  }

  @Action(Update)
  updateWithoutImmer(state: UserListState, { user  }: Update) {
    return {
      ...state,
      users: [
        ...state.users.filter(({ id }) => id !== user.id),
        user,
      ]
    }
  }

  // Update an object-map

  @Action(Update)
  updateUsingImmer(state: UserListState, { user  }: Update) {
    state.usersMap[user.id] = user;
  }

  @Action(Update)
  updateWithoutImmer(state: UserListState, { user  }: Update) {
    return {
      ...state,
      usersMap: [
        ...state.usersMap,
        [user.id]: user,
      ]
    }
  }
}

you can use both in the same time, choose the one that you prefer 😄