Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

jsonpatch

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jsonpatch

An implementation of JSON Patch and JSON Pointer IETF RFCs

  • 3.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
11K
decreased by-13.45%
Maintainers
1
Weekly downloads
 
Created
Source

JSONPatch

An implementation of the JSONPatch and JSONPointer IETF RFCs that works in Node.JS and the Browser (as a plain module or with AMD).

A Dharmafly project written by Thomas Parslow tom@almostobsolete.net and released with the kind permission of NetDev.

For full documentation, see jsonpatchjs.com

Build Status browser support

Quick Example

    mydoc = {
      "baz": "qux",
      "foo": "bar"
    };
    thepatch = [
      { "op": "replace", "path": "/baz", "value": "boo" }
    ]
    patcheddoc = jsonpatch.apply_patch(mydoc, thepatch);
    // patcheddoc now equals {"baz": "boo", "foo": "bar"}}

And that's all you need for basic use. If the patch is invalid or won't apply then you'll get an error thrown. The original doc is NOT mutated so you can use it for other things afterwards, mutating the document is supported via a flag if you need it.

For more see the docs.

Is it any good?

Yes, I hope so

Does it work in the browser?

Yes. The tests will run in the browser as well if you want to check. It's been tested in modern browsers and even in IE6!

Does it work with Node.JS?

Yes. Install with:

npm install jsonpatch

Are there tests?

Yes, there are tests. It also passes JSHint. You can (and should) run the tests yourself by running this from the project directory:

npm test

Or you can open test/runner.html in a browser of your choice.

We're using Travis and Testling CI to automatically run the tests on Node.JS and in a range of browsers every time a change is commited to this repository. The badges at the top of this readme display the current build status (which should always be passing).

Origin of the project

Dharmafly is currently working to create a collaboration web app for NetDev that comprises a Node.js RESTful API on the back-end and an HTML5 Backbone.js application on the front. The JSONPatch library was created as an essential part of the RESTful API, and has been subsequently open sourced for the community with NetDev's permission.

I've fixed/improved stuff

Great! Send me a pull request through GitHub or get in touch on Twitter @almostobsolete or email at tom@almostobsolete.net

Keywords

FAQs

Package last updated on 06 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc