From 0976a0d3e7fda62055d189e14248653f2b945be2 Mon Sep 17 00:00:00 2001 From: truffle Date: Sat, 30 May 2026 23:11:14 +0000 Subject: [PATCH 1/3] docs: add `Bun.deepEquals` to deep-equal replacements page --- docs/modules/deep-equal.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/modules/deep-equal.md b/docs/modules/deep-equal.md index 8d230119..25589634 100644 --- a/docs/modules/deep-equal.md +++ b/docs/modules/deep-equal.md @@ -21,6 +21,28 @@ equal(a, b) // true [!code --] isDeepStrictEqual(a, b) // true [!code ++] ``` +## `Bun.deepEquals` (native, Bun) + +Bun exposes [`Bun.deepEquals`](https://bun.com/docs/runtime/utils#bun-deepequals) globally on the Bun runtime. It accepts two values to compare and an optional `strict` flag (default `false`). + +Example: + +```ts +import equal from 'deep-equal' // [!code --] + +const a = { foo: 'bar' } +const b = { foo: 'bar' } + +equal(a, b) // true [!code --] +Bun.deepEquals(a, b) // true [!code ++] +``` + +For behavior equivalent to `deep-equal`'s strict mode, pass `true` as the third argument: + +```ts +Bun.deepEquals(a, b, true) +``` + ## `dequal` [`dequal`](https://github.com/lukeed/dequal) has the same simple API as `deep-equal`. From 3d1f2a6d27681ba2021de55678b1bdc4b5737135 Mon Sep 17 00:00:00 2001 From: truffle Date: Sun, 31 May 2026 00:01:51 +0000 Subject: [PATCH 2/3] docs(deep-equal): move `Bun.deepEquals` section to end of file --- docs/modules/deep-equal.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/modules/deep-equal.md b/docs/modules/deep-equal.md index 25589634..dc0c5467 100644 --- a/docs/modules/deep-equal.md +++ b/docs/modules/deep-equal.md @@ -21,41 +21,41 @@ equal(a, b) // true [!code --] isDeepStrictEqual(a, b) // true [!code ++] ``` -## `Bun.deepEquals` (native, Bun) +## `dequal` -Bun exposes [`Bun.deepEquals`](https://bun.com/docs/runtime/utils#bun-deepequals) globally on the Bun runtime. It accepts two values to compare and an optional `strict` flag (default `false`). +[`dequal`](https://github.com/lukeed/dequal) has the same simple API as `deep-equal`. Example: ```ts import equal from 'deep-equal' // [!code --] +import dequal from 'dequal' // [!code ++] const a = { foo: 'bar' } const b = { foo: 'bar' } equal(a, b) // true [!code --] -Bun.deepEquals(a, b) // true [!code ++] -``` - -For behavior equivalent to `deep-equal`'s strict mode, pass `true` as the third argument: - -```ts -Bun.deepEquals(a, b, true) +dequal(a, b) // true [!code ++] ``` -## `dequal` +## `Bun.deepEquals` (native, Bun) -[`dequal`](https://github.com/lukeed/dequal) has the same simple API as `deep-equal`. +Bun exposes [`Bun.deepEquals`](https://bun.com/docs/runtime/utils#bun-deepequals) globally on the Bun runtime. It accepts two values to compare and an optional `strict` flag (default `false`). Example: ```ts import equal from 'deep-equal' // [!code --] -import dequal from 'dequal' // [!code ++] const a = { foo: 'bar' } const b = { foo: 'bar' } equal(a, b) // true [!code --] -dequal(a, b) // true [!code ++] +Bun.deepEquals(a, b) // true [!code ++] +``` + +For behavior equivalent to `deep-equal`'s strict mode, pass `true` as the third argument: + +```ts +Bun.deepEquals(a, b, true) ``` From 002479d80017fcea5ac8524c2fc15def0f49e970 Mon Sep 17 00:00:00 2001 From: truffle Date: Sun, 31 May 2026 14:09:14 +0000 Subject: [PATCH 3/3] docs(deep-equal): tighten Bun.deepEquals intro + collapse strict mode into one example --- docs/modules/deep-equal.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/modules/deep-equal.md b/docs/modules/deep-equal.md index dc0c5467..aeff5722 100644 --- a/docs/modules/deep-equal.md +++ b/docs/modules/deep-equal.md @@ -40,7 +40,7 @@ dequal(a, b) // true [!code ++] ## `Bun.deepEquals` (native, Bun) -Bun exposes [`Bun.deepEquals`](https://bun.com/docs/runtime/utils#bun-deepequals) globally on the Bun runtime. It accepts two values to compare and an optional `strict` flag (default `false`). +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`). Example: @@ -52,10 +52,8 @@ const b = { foo: 'bar' } equal(a, b) // true [!code --] Bun.deepEquals(a, b) // true [!code ++] -``` - -For behavior equivalent to `deep-equal`'s strict mode, pass `true` as the third argument: -```ts -Bun.deepEquals(a, b, true) +// Strict Mode +equal(a, b, { strict: true }) // true [!code --] +Bun.deepEquals(a, b, true) // true [!code ++] ```