npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

immer-deps

0.0.2 • Public • Published

Immer-deps

Auto update dependencies, when immer's produce.

This providing way to manage normalized (tree|graph) structure.

Current status: API designing

Conepts

  • Strongly typed
  • Keep immer's produce API
  • Support tree and graph structure

Why?

See below, Thats two state are same structure in mental model.

const state = {
  tasks: {
    id: 1,
    name: 'task1',
    children: [{
      id: 2,
      name: 'task2',
      children: [{
        id: 3,
        name: 'task3'
      }]
    }]
  }
};
 
const next = produce(state, draft => {
  draft.tasks.children[0].children[0].name = 'task3 - updated';
});
 
expect(next.tasks).not.toEqual(state.tasks);                                                 // `task1` updated.
expect(next.tasks.children[0]).not.toEqual(state.tasks.children[0]);                         // `task2` updated.
expect(next.tasks.children[0].children[0]).not.toEqual(state.tasks.children[0].children[0]); // `task3` updated.
const state = {
  tasks: [{
    id: 1,
    name: 'task1',
    parentId: null
  }, {
    id: 2,
    name: 'task2',
    parentId: 1
  }, {
    id: 3,
    name: 'task3',
    parentId: 2
  }]
};
 
const next = produce(state, draft => {
  draft.tasks[2].name = 'task3 - updated';
});
 
expect(next.tasks[0]).not.toEqual(state.tasks[0]); // `task1` updated <- not work.
expect(next.tasks[1]).not.toEqual(state.tasks[1]); // `task2` updated <- not work.
expect(next.tasks[2]).not.toEqual(state.tasks[2]); // `task3` updated.

immer-deps solve this problem.

Usage

import { produce } from 'immer';
import { deps } from 'immer-deps';
 
type State = {
  tasks: {
    id: number;
    name: string;
    parentId: number | null;
  }[];
};
 
/**
 * Wrap produce function.
 */
const produceWithDeps = deps<State>(produce, define => ([
 
  /**
   * Define dependencies on part of state.
   */
  define('tasks', Number)((state, task) => (
    state.tasks.filter(t => t.id === task.parentId
  ) /* will needs option here? */)
 
]));
 
const stateState = {
  tasks: [
    { id: 1, name: 'todo1', parentId: null },
    { id: 2, name: 'todo2', parentId: 1 },
    { id: 3, name: 'todo3', parentId: 2 },
  ]
};
 
const next = produceWithDeps(state, state => {
  state.tasks[2].name = 'todo3 - updated';
});
 
// `state.tasks[0]` was updated via dependent on `state.tasks[1]`.
// `state.tasks[1]` was updated via dependent on `state.tasks[2]`.
// `state.tasks[2]` was updated via it self`.

Todo

  • Support immer's produce API
  • Support environments without Symbol
  • Testing in real world apps

install

npm i immer-deps

Downloadsweekly downloads

4

version

0.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability