immutability-helper-x's Introduction

immutability-helper-x

The library extends the kolodny/immutability-helper to support update by path string, like the get/set in lodash.

install

npm install -S immutability-helper-x

usage

import update, { updateChain } from 'immutability-helper-x';

const data = {
  a: {
    b: {
      c: 1,
      d: 2,
      e: [3, 2, 1],
    }
  },
  f: 4,
};

// 1. if you want to update the value of data.a.b, you can
update.$set(data, 'a.b', newValue);
// or
update.$set(data, ['a', 'b'], newValue);

// 2. other methods like push and apply in original update lib
update.$push(data, 'arr', ['car', 'bus']);
update.$apply(data, 'a.b', value => ++value);

// 3. extend method
// step 1
update.extend('$addtax', function(tax, original) {
  return original + (tax * original);
});
// step 2
update.$addtax(data, 'price', 0.8);
// or
update(data, {
  price: { $addtax: 0.8 },
});

// 4. update multiple values at the same time in a chain
const d = updateChain(data)
  .$set('a.b.c', 444)
  .$merge('a.b', {
    d: 555,
  })
  .$push('a.e', [4])
  .$unshift('a.e', [0])
  .$splice('a.e', [[1, 0, 8]])
  .$apply('a.b.d', val => val + 100)
  .value();

immutability-helper-x's People

Contributors

Stargazers

Watchers

immutability-helper-x's Issues

请教下性能上immutability-helper-x（或者immutability-helper）和 immutable-js 有区别吗？

could u add some detailed usages?

When i first see the documentation, I want to learn how to change some values of obj at same time.
I would like add this example to the doc:

// in redux
(state) => {
    return ({ ...state, fetching: true })
   // same as
   return update.$set(state, 'fetching', true)
  }

(state, action) => {
    return ({ ...state, fetching: false, text: state.text.concat(action.payload) })
   // same as
    return updateChain(state)
      .$set('fetching', false)
      .$push('text', [action.payload])
      .value()
  },