diff

Structural object diff.

Returns true when both inputs are deeply equal, otherwise a DiffResult describing the differences key by key.

Comparison rules:

Same reference \u2192 true.
Either side is null/undefined (and not both) \u2192 false.
Both Date \u2192 epoch comparison.
Both arrays \u2192 compared with array/equalsDeep (leaf, no diff drill-down).
Special objects (Map, Set, RegExp, Promise, class instances\u2026) \u2192 reference equality.
Plain objects \u2192 key-by-key, recursing up to options.depth levels.
Mixed types (e.g. array vs object, Date vs object) \u2192 false.

For a boolean wrapper see equalsDeep from this category. For a one-level boolean check see equalsShallow from this category.

Available since v2.0.0

Import

import { diff } from '@helpers4/object';

diff(objA: object | null | undefined, objB: object | null | undefined, options: DiffOptions): boolean | DiffResult

Parameter	Type	Description
`objA`	`object \| null \| undefined`	First value (object, `null`, or `undefined`).
`objB`	`object \| null \| undefined`	Second value (object, `null`, or `undefined`).
`options`	`DiffOptions`	See DiffOptions.

boolean | DiffResult — true when equal, otherwise a DiffResult, or false for incompatible types.

Deeply compares two objects, returning true when they are structurally equal.

diff({ a: { b: 1 } }, { a: { b: 1 } })
// => true

Returns a detailed diff object when nested values differ.

diff({ a: { b: 1 } }, { a: { b: 2 } })
// => { a: { b: false } }

Options for diff.

interface DiffOptions {
  depth?: number;
}

Per-key diff result. Each entry tells what differs between the two objects:

interface DiffResult {}