assert.equal()

version added: 1.0

equal( actual, expected [, message ] )

A non-strict comparison of two values.

Description

The equal assertion uses the simple comparison operator (==) to compare the actual and expected arguments. When they are equal, the assertion passes; otherwise, it fails. When it fails, both actual and expected values are displayed in the test result, in addition to a given message.

This method is similar to the assertEquals() method found in xUnit-style frameworks.

notEqual() can be used to explicitly test inequality.

strictEqual() can be used to test strict equality.

Changelog

• Prior to QUnit 1.1, this method was known as assert.equals.
  The alias was removed in QUnit 1.3.

Examples

The simplest assertion example:

QUnit.test( "a test", function( assert ) {
  assert.equal( 1, "1", "String '1' and number 1 have the same value" );
});

A slightly more thorough set of assertions:

QUnit.test( "equal test", function( assert ) {
  assert.equal( 0, 0, "Zero, Zero; equal succeeds" );
  assert.equal( "", 0, "Empty, Zero; equal succeeds" );
  assert.equal( "", "", "Empty, Empty; equal succeeds" );

  assert.equal( "three", 3, "Three, 3; equal fails" );
  assert.equal( null, false, "null, false; equal fails" );
});