immutable-set

Immutable set

This tools aims to facilitate the modification of nested property while preserving immutable principles. Lets say you have the given object:

const state = {
  a: {
    foo: 'bar',
  },
  b: {
    value: 3,
  },
};

If we want to increment b.value, immutability says that we should generate a new object where

newState === state        // false
newState.b === state.b    // false
newState.a === state.a    // true

That exactly what does our set function,

Setup

Add the dependency to your project:

yarn add immutable-set

Parameters

name	description	type
base	object to modify	object
path	list of keys to access the value to being modified	array
value	value to set	any
withArray (optional)	if set to true number will be interpreted has array indexes	boolean

Usage

Import set function

import set from 'immutable-set';

Then set the property you want in your object

const newState = set(state, ['a', 0, 'b'], 42, true);
/*
 newState => {
               a: [
                 {
                   b: 42,
                 },
               ],
               ...
             }
 */