npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-mini-patch

v2.0.1

Published

small minimal JSON patch implementation

Downloads

6

Readme

json-mini-patch

JSON Patch RFC 6902 compliant - small, simple, no dependencies, 3kb minified, 1kb gzip

WhyWhatHowLicense

Why

This is a bare-bone JSON Patch implementation with the internal parsed patch exposed. This is useful for cases where additional processing and logic is required by store or database middleware.

When processing a JSON Patch, the string path must be parsed and unescaped into a series of object keys. By seperating the processing and implementation of the patch, it is easier to use this implementation as a base for more complex object stores.

What

//CJS
var jsm = require('json-mini-patch')
var newState = jsm.jsonpatch(oldState, [{op: 'add', path: '/new/key', value: 'newValue'}]) //standard compliant
var minPatch = jsm.compress([{op: 'add', path: '/newKey', value: 'newValue'}]) //[['a', ['new','key'], 'newValue']]
var stdPatch = jsm.restore(minPatch) // back to the original standard patch
var newState = jsm.patch(oldState, minPatch) // patch
//ES6
import {jsonpatch, compress, restore, patch} from 'json-mini-patch'
var newState = patch.std(oldState, [{op: 'add', path: '/new/key', value: 'newValue'}]) //standard compliant
var minPatch = patch.s2m([{op: 'add', path: '/newKey', value: 'newValue'}]) //[['a', ['new','key'], 'newValue']]
var stdPatch = patch.m2s(minPatch) // back to the original standard patch
var newState = patch.min(oldState, minPatch) // patch

Features

  • RFC 6902 compliant with the full test-suit used
  • throws for non-compliant patches but not for tests. This allows test operations to prevent throwing
  • operation are atomic and the source object is immutable. If a test fails the patch is canceled and the original object is returned
  • under 4kb minified
  • available in cjs (require), es6 (import) or browser (script) formats

API

  • jsonpatch(object, actions) => newObject applies a JSON patch to the object
  • compress(actions) => [[o, p, v]] returns a compressed patch.
    • o: operation 'a':add, 'r':replace, 'd':remove, 't':test, 'm':move, 'c':copy
    • p: array of path keys. [] for the root
    • v: value or from field depending on the operation
  • patch(object, compressed) => newObject applies a parsed patch to the object
  • restore(compressed) => actions converts a parsed patch back to a compliant JSON Patch

License

Released under the MIT License