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

@stackomate/json-diff

v0.1.1

Published

`@stackomate/json-diff` unites two widely-used packages, [`fast-json-patch`](https://www.npmjs.com/package/fast-json-patch) and [`diff`](https://www.npmjs.com/package/diff), to produce a succint [`JSON Patch`](https://jsonpatch.com/) from two JSON objec

Downloads

4

Readme

json-diff

@stackomate/json-diff unites two widely-used packages, fast-json-patch and diff, to produce a succint JSON Patch from two JSON objects.

Differences (pun intended)

  • In contrast with fast-json-patch, @stackomate/json-diff will also attempt to track moved items in arrays. This will often generate a JSON patch with a smaller payload and more easily interpreted by humans.

For example, given a baseJSON and a resultJSON defined below, both packages will produce valid patches, although fast-json-patch will focus on performance while @stackomate/json-diff will focus on simplifying the final JSON patch object:

const baseJSON = [
    'a',
    'b',
    'c'
];

const resultJSON = [
    'b',
    'c',
    'd'
];
// fast-json-patch

import { compare } from 'fast-json-patch';
console.log(compare(baseJSON, resultJSON));

// [ 
//     { op: "replace", path: "/2", value: "d" }
//     { op: "replace", path: "/1", value: "c" }
//     { op: "replace", path: "/0", value: "b" }
// ]
// @stackomate/json-diff
import {jsonDiff} from '@stackomate/json-diff';
console.log(jsonDiff(baseJSON, resultJSON));

// [ 
//     { op: 'remove', path: '/0' }, 
//     { op: 'add', path: '/2', value: 'd' } 
// ]

Usage

  • For basic usage with primitives only, call the jsonDiff method with the initial and final json objects:
jsonDiff(initialJSON, finalJSON)
  • Recommended: Add a trackFunction to help our algorithm identify nested objects in arrays. For example, an id field is commonly used as key:
jsonDiff(initialJSON, finalJSON, (item) => item?.id)
  • Important:
    • All keys returned by the function should be unique;
    • This function should aim to return a value !== undefined; Returning undefined for any of the analyzed values will fallback to the default behavior from fast-json-patch for all items in the same array.