remove(path, [n]) ⇒ object

Removes item from object or array

Returns: object - action object
Params

• path number | string | Array.<(string|number)> - path to be updated (array of items or dot-separated string can be provided)
• [n] number - number of items to remove (works only for arrays)

Description

This action can remove items from both arrays and objects:

import { ACTIONS, reducer } from 'general-reducer';

const state = {
    a: {
        a1: 1,
        a2: 2
    },
    b: [ 1, 2, 3, 4 ]
};

const updated = reducer(state, ACTIONS.remove('a.a1'));

// or

const updated = reducer(state, ACTIONS.remove([ 'a', 'a1' ]));

As a result we will receive new object with structure below:

{
    a: {
        a2: 2
    },
    b: [ 1, 2, 3, 4 ]
}

To remove items from an array the path should ends with number:

const updated = reducer(state, ACTIONS.remove('b.1'));

By default one item will be removed:

{
    a: {
        a2: 2
    },
    b: [ 1, 3, 4 ]
}

To remove several items just provide number as 2nd argument:

const updated = reducer(state, ACTIONS.remove('b.1', 2));

According number of items will be removed:

{
    a: {
        a2: 2
    },
    b: [ 1, 4 ]
}