Skip to content

Commit d02204a

Browse files
authored
docs: add Bun.deepEquals to deep-equal replacements page (#699)
* docs: add `Bun.deepEquals` to deep-equal replacements page * docs(deep-equal): move `Bun.deepEquals` section to end of file * docs(deep-equal): tighten Bun.deepEquals intro + collapse strict mode into one example
1 parent ae26e89 commit d02204a

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/modules/deep-equal.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,23 @@ const b = { foo: 'bar' }
3737
equal(a, b) // true [!code --]
3838
dequal(a, b) // true [!code ++]
3939
```
40+
41+
## `Bun.deepEquals` (native, Bun)
42+
43+
Bun has a built-in [`Bun.deepEquals`](https://bun.com/docs/runtime/utils#bun-deepequals) function. It accepts two values to compare, and an optional `strict` flag (default `false`).
44+
45+
Example:
46+
47+
```ts
48+
import equal from 'deep-equal' // [!code --]
49+
50+
const a = { foo: 'bar' }
51+
const b = { foo: 'bar' }
52+
53+
equal(a, b) // true [!code --]
54+
Bun.deepEquals(a, b) // true [!code ++]
55+
56+
// Strict Mode
57+
equal(a, b, { strict: true }) // true [!code --]
58+
Bun.deepEquals(a, b, true) // true [!code ++]
59+
```

0 commit comments

Comments
 (0)