Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

A deep equality checking assertion...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
deepEqual( expectedactual, actualexpected, message );

Parameters

ParameterTypeMandatoryNotesAPI Version
expectedactualVariant(tick)The expected actual value.1.0
actualexpectedVariant(tick)The actual 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

Code Block
themeRDark
languagejavascript
linenumberstrue
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.

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Test API

Topics:

Child pages (Children Display)
alltrue
depthall
pageTest API
excerpttrue