A deep equality checking assertion...

 

Syntax

deepEqual( actual, expected, message );

Parameters

ParameterTypeMandatoryNotesAPI Version
actualVariant(tick)The actual value.1.0
expectedVariant(tick)The expected value.1.0
messageString(tick)A message stating what the assertion is testing.1.0

Return Values

ValueTypeNotesAPI Version
<error>ErrorMost likely the parameters are wrong.1.0
trueBooleanexpected == actual to at least 10 levels deep.1.0
falseBooleanexpected != actual to at least 10 levels deep.1.0

Example

Test("Deep equality checks", Test.ANY( ), function() {
	// assertions will pass
	deepEqual( {a:5}, {a:5}, "{a:5} == {a:5}?" );
	// assertion will fail
	deepEqual( {a:5}, {a:1}, "{a:5} == {a:1}?" );
});

Notes

This is a greatly simplified version of deepEqual( ) compared to its QUnit counterpart.

Availability

Requires:

Contents

Jump to:

Test API

Topics: