Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

toEqual()

The toEqual() method asserts that the actual value is deeply equal to the expected value, performing recursive comparison of objects and arrays.

Syntax

JavaScript
expect(actual).toEqual(expected);
expect(actual).not.toEqual(expected);

Parameters

ParameterTypeDescription
expectedanyThe expected value

Returns

TypeDescription
voidNo return value

Description

The toEqual() method performs deep equality comparison, recursively checking all properties of objects and elements of arrays. Unlike toBe(), it compares the content of objects rather than their references.

Use toEqual() when you want to assert that two values have the same structure and content, even if they are different objects in memory.

Usage

JavaScript
import { expect } from 'https://jslib.k6.io/k6-testing/0.6.1/index.js';

export default function () {
  const user1 = { name: 'John', age: 30 };
  const user2 = { name: 'John', age: 30 };

  expect(user1).toEqual(user2);
  expect(user1).not.toBe(user2); // Different references
}