Skip to main content

Bun home page

[Runtime

](../../../index.md)[Package Manager

](../../../pm/cli/install/index.md)[Bundler

](../../../bundler/index.md)[Test Runner

](../../../test/index.md)[Guides

](../../index.md)[Reference

](https://bun.com/reference)[Blog

](https://bun.com/blog)[Feedback

](../../../feedback/index.md)

Check if two objects are deeply equal. This is used internally by expect().toEqual() in Bun’s test runner.

index.ts

const a = { a: 1, b: 2, c: { d: 3 } };
const b = { a: 1, b: 2, c: { d: 3 } };

Bun.deepEquals(a, b); // true

Pass true as a third argument to enable strict mode. This is used internally by expect().toStrictEqual() in Bun’s test runner. The following examples would return true in non-strict mode but false in strict mode.

index.ts

// undefined values
Bun.deepEquals({}, { a: undefined }, true); // false

// undefined in arrays
Bun.deepEquals(["asdf"], ["asdf", undefined], true); // false

// sparse arrays
Bun.deepEquals([, 1], [undefined, 1], true); // false

// object literals vs instances w/ same properties
class Foo {
  a = 1;
}
Bun.deepEquals(new Foo(), { a: 1 }, true); // false

See Docs > API > Utils for more useful utilities.

Was this page helpful?

Suggest editsRaise issue

[

Escape an HTML string

Previous

](../escape-html/index.md)[

Sleep for a fixed number of milliseconds

Next

](../sleep/index.md)