A basic equality checking assertion...

 

Syntax

equal( 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.1.0
falseBooleanexpected != actual.1.0

Example

Test("Inequality checks", Test.ANY( ), function() {
	// assertions will pass
	equal( true, true, "true == true?" );
	equal( undefined, null, "undefined == null?" );
	equal( null, false, "null == false?" );
	equal( "fish", true, "'fish' == true?" );
	// assertion will fail
	equal( true, false, "true == false?" );
	// and for some fun... NaN != NaN, ever!
	equal( NaN, NaN, "NaN == NaN?" ); // WAT?!
	// https://www.destroyallsoftware.com/talks/wat
	// https://coderwall.com/p/sekogw
});
Availability

Requires:

Contents

Jump to:

Test API

Topics: