package
Immutable JSON patch with support for reverting operations
npm install immutable-json-patchGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
232.5 kB
Includes dependencies.
Immutable JSON patch with support for reverting operations.
Features:
Try it out on a playground: https://josdejong.github.io/immutable-json-patch/
See http://jsonpatch.com/ for a clear description of the JSONPatch standard itself.
$ npm install immutable-json-patchNote that in the lib folder, there are builds for ESM, UMD, and CommonJs.
ESM:
import { immutableJSONPatch, revertJSONPatch } from 'immutable-json-patch'CommonJs:
const { immutableJSONPatch, revertJSONPatch } = require('immutable-json-patch')Example from http://jsonpatch.com/#simple-example, using immutable-json-patch:
import { immutableJSONPatch, revertJSONPatch } from 'immutable-json-patch'
const document = {
baz: 'qux',
foo: 'bar'
}
console.log('document', document)
const operations = [
{ op: 'replace', path: '/baz', value: 'boo' },
{ op: 'add', path: '/hello', value: ['world'] },
{ op: 'remove', path: '/foo' }
]
console.log('operations', operations)
const updatedDocument = immutableJSONPatch(document, operations)
Apply a list with JSON Patch operations to a JSON document.
declare function immutableJSONPatch<T, U = unknown> (document: T, operations: JSONPatchDocument, options?: JSONPatchOptions) : UWhere:
document: T is a JSON document
operations: JSONPatchDocument is an array with JSONPatch operations
options: JSONPatchOptions is an optional object allowing passing hooks before and after. With those hooks it is possible to alter the JSON document and/or applied operation before and after this is applied. This allows for example to instantiate classes or additional data structures when applying a JSON patch operation. Or you can keep certain data stats up to date. For example, it is possible to have an array with Customer class instances, and instantiate a new Customer when an add operation is performed. And in this library itself, the before callback is used to create inverse operations whilst applying the actual operations on the document.
The callbacks look like:
const options = {
before: (document: unknown, operation: JSONPatchOperation) => {
console.log('before operation', { document, operation })
// return { document?: unknown, operation?: JSONPatchOperation } | undefined
},
after: (document: unknown, operation:
The function returns an updated JSON document where the JSON patch operations are applied. The original JSON document is not changed.
Generate the JSON patch operations that will revert the provided list with JSON Patch operations when applied to the provided JSON document.
declare function revertJSONPatch<T, U> (document: T, operations: JSONPatchDocument, options?: RevertJSONPatchOptions) : JSONPatchDocumentWhere:
document: T is a JSON documentoperations: JSONPatchDocument is an array with JSONPatch operationsoptions: JSONPatchOptions is an optional object allowing passing a hook before. With this hook it is possible to alter the JSON document and/or generated reverseOperations before this is applied.The function returns a list with the reverse JSON Patch operations. These operations can be applied to the updated JSON document (the output of immutableJSONPatch) to restore the original JSON document.
The library exposes a set of utility functions and typeguards to work with JSON pointers and to do immutable operations on JSON data:
declare function parsePath<T>(document: T, path: JSONPointer): JSONPath
declare function parseFrom(path: JSONPointer): JSONPath
declare function parseJSONPointer (pointer: JSONPointer) : JSONPath
declare function compileJSONPointer (path: JSONPath) : JSONPointer
declare function compileJSONPointerProp (pathProp: string | number) : JSONPointer
declare function appendToJSONPointer (pointer: JSONPointer, pathProp: string
To build the library (ESM, CommonJs, and UMD output in the folder lib):
$ npm install
$ npm run buildTo run the unit tests:
$ npm testTo run the linter (biomejs):
$ npm run lintTo run the linter, build all, and run unit tests and integration tests:
$ npm run build-and-testReleased under the ISC license.
When the before or after callback returns an object with altered document, this will be used to apply the operation. When and altered operation is returned from before in an object, this operation will be applied instead of the original operation.