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

deep-merge-changes

v0.1.1

Published

Merges two or more objects, returning the same reference if the objects are equal.

Downloads

4

Readme

deep-merge-changes

Merges two or more objects, returning the same reference if the objects are equal.

This utility is helpful in situations where an object of arbitrary depth needs to be overwritten with new data. If the data in the object is the same, the original object reference is returned. When using tools that update depending on changes to immutable values (like React or Redux), this provides a performance optimization, preventing unnecessary re-renders when the selected data has not actually changed.

Installation

# npm
npm install deep-merge-changes

# yarn
yarn add deep-merge-changes

Example

import assert from 'assert'
import { deepMergeChanges, OMIT } from 'deep-merge-changes'

const current = {
  a: { x: 1, y: 2, z: { w: 3 } },
  b: { x: 4, y: [5, 6, 7] },
}

const changes = {
  a: { x: 1.5, y: OMIT },
  b: { y: { 1: 6.5 } },
}

const result = deepMergeChanges(current, changes)

assert.deepStrictEqual(result, {
  a: { x: 1.5, z: { w: 3 } },
  b: { x: 4, y: [5, 6.5, 7] },
})

assert.strictEqual(result.a.z, current.a.z)

See ./lib/index.spec.js for more examples.

Behavior

  1. If the current object is shallowly equal to the result of merging the current object with the changes, the current object is returned.
  2. If a property or array element in the changes is set to the OMIT symbol, the corresponding property or element is removed from the result.
  3. If the current object is an array and the changes object is an object, the keys of the changes object represent array indexes and the values in the result array will be the current elements merged with the changes.
  4. If both the current object and the changes object are arrays, the result will completely replace the current array with the changes array, unless they are equal.
  5. If changes is not a plain object or array, the result is the changes value.

API

deepMergeChanges(current, ...changes): any

|Argument|Type|Description| |:---|:---|:---| |current|any|The current value.| |changes|Array<any>|The changes to merge with the current value.|

Returns the merged result.

OMIT

A Symbol that signifies that the corresponding property or array index should be removed from the result if it exists.