mutant-json v0.6.3

mutant-json

A complete mutant json which uses traverse-json to enable traverse filtering.

Motivation

Many time I've encontered with the difficult task of mutate a object with nested properties by filtering properties using a single function, so a mutant-json solves this using traverse-json with multiple options for traversing.

Installation

Npm:

npm install mutant-json --save

Yarn:

yarn add mutant-json

Functions

Typedefs

mutantJson(target, process, opts)

Iterates through the given iterator and applies mutation whereas the iterator entry returns. Also works with promises. The iteratee must return an entry of path, value.

Kind: global function

Example

Working with promises

const mutateJson = require('mutant-json');

const recursiveObjectPromises = {
  foo: 0,
  nested: Promise.resolve({
    depth: 1,
    nested: Promise.resolve({
      depth: 2,
      nested: Promise.resolve({
        depth: 3,
        nested: Promise.resolve({
          depth: 4,
        }),
      }),
    }),
  }),
  bar: 1,
};

const actual = await mutateJson(recursiveObjectPromises, (mutate, value) => {
  mutate({
    value: value * 2,
  });
});

console.log(actual);

Output

{
  foo: 0,
  nested: {
    depth: 2,
    nested: {
      depth: 4,
      nested: {
        depth: 6,
        nested: {
          depth: 8,
        },
      },
    },
  },
  bar: 2,
}

MutanPatch : function

Patch definition acording to the jsonpatch standard

Kind: global typedef

MutantPatcher : function

Kind: global typedef

MutantProcess : function

Kind: global typedef

MutantJsonEntry : Array

Kind: global typedef
Properties

MutantOptions : Object

Kind: global typedef
Properties