Check Deep Equality

isDeepEqual

Performs a deep comparison between two values (arrays, objects, and primitives) to determine if they are structurally and value-wise equal.

Import

import { isDeepEqual } from 'toolbox-x';
// or
import { isDeepEqual } from 'toolbox-x/guards';

Signature

isDeepEqual(a: unknown, b: unknown): boolean

Usage Examples

API Reference

Parameters

Returns

• true if the values are deeply equal.
• false otherwise.

How it Works

• Strict Equality First: If a and b are the same reference or primitive value, returns true immediately.
• Type & Null Checks: If types differ or either value is null, returns false unless both are strictly equal.
• Array Handling: Arrays compared recursively, including nested arrays.
• Object Handling: Objects compared recursively, ensuring both keys and values match exactly.
• Shallow/Deep: Works for deeply nested arrays/objects as well as simple values.

Key Features

• Recursive & Robust: Handles arbitrary nesting for arrays and objects.
• Type Safety: Works generically for any consistent types.
• Foundational Utility: This deep comparison utility powers internal checks across many toolbox functions (e.g., deduplication, merging, diffing, and more).

Notes

• If you compare objects with arrays, types, or keys in different order but same values, equality will follow JavaScript’s structure (order matters in arrays, not in objects).
• For performance sensitive code, avoid using on excessively large or deeply nested structures unless necessary.
• This function is extensively used internally in toolbox-x for object/array equality checks.

Recommended Use Cases

• Deduplicating structurally equal objects/arrays.
• Testing and assertion helpers.
• Data merging, diffing, or synchronization.
• Safely comparing complex API payloads or configurations.