Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

deepEquals.md

45 lines884 Bytes

1---
2id: deepEquals
3title: deepEquals
4---
5​
6# Function: deepEquals()
7​
8```ts
9function deepEquals(a, b): boolean;
10```
11​
12Defined in: [packages/db/src/utils.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/utils.ts#L29)
13​
14Deep equality function that compares two values recursively
15Handles primitives, objects, arrays, Date, RegExp, Map, Set, TypedArrays, and Temporal objects
16​
17## Parameters
18​
19### a
20​
21`any`
22​
23First value to compare
24​
25### b
26​
27`any`
28​
29Second value to compare
30​
31## Returns
32​
33`boolean`
34​
35True if the values are deeply equal, false otherwise
36​
37## Example
38​
39```typescript
40deepEquals({ a: 1, b: 2 }, { b: 2, a: 1 }) // true (property order doesn't matter)
41deepEquals([1, { x: 2 }], [1, { x: 2 }]) // true
42deepEquals({ a: 1 }, { a: 2 }) // false
43deepEquals(new Date('2023-01-01'), new Date('2023-01-01')) // true
44deepEquals(new Map([['a', 1]]), new Map([['a', 1]])) // true
45```