Documentation

QUnit/equal

From jQuery JavaScript Library

(Redirected from QUnit/equals)
Jump to: navigation, search

« Back to QUnit

equal( actual, expected, [message] )

A comparison assertion, equivalent to JUnit's assertEquals.
Similar to ok(), but outputs both actual and expected values, making debugging much easier. Whenever you compare non-boolean values, use this instead of ok. While the test is equivalent to JUnit's assertEquals, the order of arguments differs from JUnit.

Passes if actual == expected.

Migration note: This method was named "equals", which is now deprecated, after adopting CommonJS naming convetions.
Arguments:

actualObject
The actual result
expectedObject
The expected result
message (Optional)String
A message to display with the assertion result

Examples:
Two simple examples of using equal.

test("a test", function() {
  var actual = 1;
  equal(actual, 1);
  equal(actual - 1, 0, "this message is added to the assertion result, useful for debugging");
});

NameType