JSON8 Merge Patch

Introduction

JSON Merge Patch RFC 7396 toolkit for JavaScript.

---

- Introduction
- Getting started
- Methods
- apply
- patch
- diff

Getting started

npm install json8-merge-patch

---

``javascript
const mergePatch = require("json8-merge-patch");
`

↑

Methods

$3

Apply a JSON Merge Patch to a JSON document.

- May mutates the target document, if you wish to pass a shallow copy use JSON8 clone.
- Does not validate the patch nor the target nor the result for JSON correctness, use JSON8 valid.

`javascript
doc = mergePatch.apply(doc, mergePatch);
`

`javascript
let person = {
"name": "John Doe",
"friendly": true,
"age": 18,
"address": {
"country": "France"
}
}

const patch = {
"age": 19,
"friendly": "maybe"
"address": {
"country": null
}
}

person = mergePatch.apply(person, patch)
/*
{
"name": "John Doe",
"friendly": "maybe",
"age": 19,
"address": {}
}
*/
`

↑

$3

When needed, apply creates objects with null prototype, you can choose the prototype to use with {proto: Object} as a third argument.

↑

$3

apply will throw with an error if prototype pollution is attempted. You can allow for prototype pollution by passing {pollute: true} as a third argument.

↑

$3

Alias for apply method.

↑

$3

Compares two JSON documents and returns a JSON Merge Patch.

`javascript
const a = { foo: "bar", bar: "foo" };
const b = { foo: "foo" };

mergePatch.diff(a, b);
/*
{
"foo": "foo",
"bar": null
}
*/
``

↑