is-shallow-equal

What is is-shallow-equal?

The is-shallow-equal npm package is a utility for performing shallow equality checks between two values. It is useful for determining if two objects or arrays are equal by comparing their properties or elements at the first level.

What are is-shallow-equal's main functionalities?

Shallow Equality Check for Objects

This feature allows you to check if two objects are shallowly equal. It compares the properties of the objects at the first level.

const isShallowEqual = require('is-shallow-equal');
const obj1 = { a: 1, b: 2 };
const obj2 = { a: 1, b: 2 };
const result = isShallowEqual(obj1, obj2);
console.log(result); // true

Shallow Equality Check for Arrays

This feature allows you to check if two arrays are shallowly equal. It compares the elements of the arrays at the first level.

const isShallowEqual = require('is-shallow-equal');
const arr1 = [1, 2, 3];
const arr2 = [1, 2, 3];
const result = isShallowEqual(arr1, arr2);
console.log(result); // true

Shallow Equality Check for Mixed Types

This feature allows you to check shallow equality between different types, such as an object and an array. It will return false if the types are different.

const isShallowEqual = require('is-shallow-equal');
const obj = { a: 1, b: 2 };
const arr = [1, 2];
const result = isShallowEqual(obj, arr);
console.log(result); // false

Other packages similar to is-shallow-equal

shallowequal

The shallowequal package provides similar functionality for performing shallow equality checks. It compares objects and arrays at the first level, just like is-shallow-equal. However, shallowequal is more widely used and has more frequent updates.

lodash.isequal

The lodash.isequal package is part of the Lodash library and provides deep equality checks. While it can perform shallow checks, its primary use case is for deep comparisons, making it more versatile but potentially more complex than is-shallow-equal.

fast-deep-equal

The fast-deep-equal package is designed for deep equality checks but can also be used for shallow comparisons. It is optimized for performance and is a good alternative if you need both shallow and deep equality checks.

README

is-shallow-equal

Shallowly compares two objects

Install

$ npm install --save is-shallow-equal

Usage

var isSquallowEqual = isShallowEqual(a, b)

Tests

$ npm run test

MIT License © Alessandro Arnodo