<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: test Assert (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>test <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_test.html" title="test">test</a>
> Assert
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
<code>static</code>
Class <b property="yui:name">Assert</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
The Assert object provides functions to test JavaScript values against
known and expected results. Whenever a comparison (assertion) fails,
an error is thrown.
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property__asserts">
<h4><a name="property__asserts" property="yui:name">_asserts</a>
- <code>private <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The number of assertions performed.
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="protected" rel="yui:method" resource="#method__formatMessage">
<h4>
<a name="method__formatMessage">_formatMessage</a></h4>
<div class="detail" >
<code>
protected
static
String
<strong property="yui:name">_formatMessage</strong>
(
customMessage
,
defaultMessage
)
</code>
<div class="description" property="yui:description">
Formats a message so that it can contain the original assertion message
in addition to the custom message.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">customMessage</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The message passed in by the developer.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">defaultMessage</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The message created by the error by default.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
String
</code></dt>
<dd property="yui:returnInfo">The final error message, containing either or both.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__getCount">
<h4>
<a name="method__getCount">_getCount</a></h4>
<div class="detail" >
<code>
protected
static
void
<strong property="yui:name">_getCount</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns the number of assertions that have been performed.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__increment">
<h4>
<a name="method__increment">_increment</a></h4>
<div class="detail" >
<code>
protected
static
void
<strong property="yui:name">_increment</strong>
(
)
</code>
<div class="description" property="yui:description">
Increments the number of assertions that have been performed.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__reset">
<h4>
<a name="method__reset">_reset</a></h4>
<div class="detail" >
<code>
protected
static
void
<strong property="yui:name">_reset</strong>
(
)
</code>
<div class="description" property="yui:description">
Resets the number of assertions that have been performed to 0.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_areEqual">
<h4>
<a name="method_areEqual">areEqual</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">areEqual</strong>
(
expected
,
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is equal to another. This uses the double equals sign
so type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">expected</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The expected value.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_areNotEqual">
<h4>
<a name="method_areNotEqual">areNotEqual</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">areNotEqual</strong>
(
unexpected
,
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not equal to another. This uses the double equals sign
so type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">unexpected</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The unexpected value.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_areNotSame">
<h4>
<a name="method_areNotSame">areNotSame</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">areNotSame</strong>
(
unexpected
,
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not the same as another. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">unexpected</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The unexpected value.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_areSame">
<h4>
<a name="method_areSame">areSame</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">areSame</strong>
(
expected
,
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is the same as another. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">expected</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The expected value.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_fail">
<h4>
<a name="method_fail">fail</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">fail</strong>
(
message
)
</code>
<div class="description" property="yui:description">
Forces an assertion error to occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display with the failure.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isArray">
<h4>
<a name="method_isArray">isArray</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isArray</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is an array.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isBoolean">
<h4>
<a name="method_isBoolean">isBoolean</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isBoolean</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is a Boolean.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isFalse">
<h4>
<a name="method_isFalse">isFalse</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isFalse</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is false. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isFunction">
<h4>
<a name="method_isFunction">isFunction</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isFunction</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is a function.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isInstanceOf">
<h4>
<a name="method_isInstanceOf">isInstanceOf</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isInstanceOf</strong>
(
expected
,
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is an instance of a particular object. This may return
incorrect results when comparing objects from one frame to constructors in
another frame. For best results, don't use in a cross-frame manner.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">expected</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The function that the object should be an instance of.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The object to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNaN">
<h4>
<a name="method_isNaN">isNaN</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNaN</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not a number.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNotNaN">
<h4>
<a name="method_isNotNaN">isNotNaN</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNotNaN</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not the special NaN value.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNotNull">
<h4>
<a name="method_isNotNull">isNotNull</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNotNull</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not null. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNotUndefined">
<h4>
<a name="method_isNotUndefined">isNotUndefined</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNotUndefined</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is not undefined. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNull">
<h4>
<a name="method_isNull">isNull</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNull</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is null. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isNumber">
<h4>
<a name="method_isNumber">isNumber</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isNumber</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is a number.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isObject">
<h4>
<a name="method_isObject">isObject</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isObject</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is an object.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isString">
<h4>
<a name="method_isString">isString</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isString</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is a string.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isTrue">
<h4>
<a name="method_isTrue">isTrue</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isTrue</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is true. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isTypeOf">
<h4>
<a name="method_isTypeOf">isTypeOf</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isTypeOf</strong>
(
expectedType
,
actualValue
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is of a particular type.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">expectedType</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The expected type of the variable.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">actualValue</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isUndefined">
<h4>
<a name="method_isUndefined">isUndefined</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">isUndefined</strong>
(
actual
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a value is undefined. This uses the triple equals sign
so no type cohersion may occur.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">actual</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The actual value to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Y.assert">
<h4>
<a name="method_Y.assert">Y.assert</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">Y.assert</strong>
(
condition
,
message
)
</code>
<div class="description" property="yui:description">
Asserts that a given condition is true. If not, then a Y.Assert.Error object is thrown
and the test fails.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">condition</span>
<<span property="yui:type">Boolean</span>>
</code>
<span property="yui:description"> The condition to test.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> The message to display if the assertion fails.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Y.fail">
<h4>
<a name="method_Y.fail">Y.fail</a></h4>
<div class="detail" >
<code>
static
void
<strong property="yui:name">Y.fail</strong>
(
message
)
</code>
<div class="description" property="yui:description">
Forces an assertion error to occur. Shortcut for Y.Assert.fail().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">message</span>
<<span property="yui:type">String</span>>
</code>
<span property="yui:description"> (Optional) The message to display with the failure.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class="selected"><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="Assert.html" title="Assert">Assert</a></li>
<li class=""><a href="Assert.ComparisonFailure.html" title="Assert.ComparisonFailure">Assert.ComparisonFailure</a></li>
<li class=""><a href="Assert.Error.html" title="Assert.Error">Assert.Error</a></li>
<li class=""><a href="Assert.ObjectAssert.html" title="Assert.ObjectAssert">Assert.ObjectAssert</a></li>
<li class=""><a href="Assert.ShouldError.html" title="Assert.ShouldError">Assert.ShouldError</a></li>
<li class=""><a href="Assert.ShouldFail.html" title="Assert.ShouldFail">Assert.ShouldFail</a></li>
<li class=""><a href="Assert.UnexpectedError.html" title="Assert.UnexpectedError">Assert.UnexpectedError</a></li>
<li class=""><a href="Assert.UnexpectedValue.html" title="Assert.UnexpectedValue">Assert.UnexpectedValue</a></li>
<li class=""><a href="Test.ArrayAssert.html" title="Test.ArrayAssert">Test.ArrayAssert</a></li>
<li class=""><a href="Test.Case.html" title="Test.Case">Test.Case</a></li>
<li class=""><a href="Test.DateAssert.html" title="Test.DateAssert">Test.DateAssert</a></li>
<li class=""><a href="Test.Format.Mock.html" title="Test.Format.Mock">Test.Format.Mock</a></li>
<li class=""><a href="Test.Manager.html" title="Test.Manager">Test.Manager</a></li>
<li class=""><a href="Test.Reporter.html" title="Test.Reporter">Test.Reporter</a></li>
<li class=""><a href="Test.Runner.html" title="Test.Runner">Test.Runner</a></li>
<li class=""><a href="Test.Suite.html" title="Test.Suite">Test.Suite</a></li>
<li class=""><a href="Test.TestNode.html" title="Test.TestNode">Test.TestNode</a></li>
<li class=""><a href="Test.Wait.html" title="Test.Wait">Test.Wait</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ArrayAssert.js.html" title="ArrayAssert.js">ArrayAssert.js</a></li>
<li class=""><a href="Assert.js.html" title="Assert.js">Assert.js</a></li>
<li class=""><a href="DateAssert.js.html" title="DateAssert.js">DateAssert.js</a></li>
<li class=""><a href="Mock.js.html" title="Mock.js">Mock.js</a></li>
<li class=""><a href="ObjectAssert.js.html" title="ObjectAssert.js">ObjectAssert.js</a></li>
<li class=""><a href="TestCase.js.html" title="TestCase.js">TestCase.js</a></li>
<li class=""><a href="TestFormat.js.html" title="TestFormat.js">TestFormat.js</a></li>
<li class=""><a href="TestManager.js.html" title="TestManager.js">TestManager.js</a></li>
<li class=""><a href="TestReporter.js.html" title="TestReporter.js">TestReporter.js</a></li>
<li class=""><a href="TestRunner.js.html" title="TestRunner.js">TestRunner.js</a></li>
<li class=""><a href="TestSuite.js.html" title="TestSuite.js">TestSuite.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__asserts" title="_asserts">_asserts</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><a href="#method__formatMessage" title="_formatMessage">_formatMessage</a></li>
<li class="protected"><a href="#method__getCount" title="_getCount">_getCount</a></li>
<li class="protected"><a href="#method__increment" title="_increment">_increment</a></li>
<li class="protected"><a href="#method__reset" title="_reset">_reset</a></li>
<li class=""><a href="#method_areEqual" title="areEqual">areEqual</a></li>
<li class=""><a href="#method_areNotEqual" title="areNotEqual">areNotEqual</a></li>
<li class=""><a href="#method_areNotSame" title="areNotSame">areNotSame</a></li>
<li class=""><a href="#method_areSame" title="areSame">areSame</a></li>
<li class=""><a href="#method_fail" title="fail">fail</a></li>
<li class=""><a href="#method_isArray" title="isArray">isArray</a></li>
<li class=""><a href="#method_isBoolean" title="isBoolean">isBoolean</a></li>
<li class=""><a href="#method_isFalse" title="isFalse">isFalse</a></li>
<li class=""><a href="#method_isFunction" title="isFunction">isFunction</a></li>
<li class=""><a href="#method_isInstanceOf" title="isInstanceOf">isInstanceOf</a></li>
<li class=""><a href="#method_isNaN" title="isNaN">isNaN</a></li>
<li class=""><a href="#method_isNotNaN" title="isNotNaN">isNotNaN</a></li>
<li class=""><a href="#method_isNotNull" title="isNotNull">isNotNull</a></li>
<li class=""><a href="#method_isNotUndefined" title="isNotUndefined">isNotUndefined</a></li>
<li class=""><a href="#method_isNull" title="isNull">isNull</a></li>
<li class=""><a href="#method_isNumber" title="isNumber">isNumber</a></li>
<li class=""><a href="#method_isObject" title="isObject">isObject</a></li>
<li class=""><a href="#method_isString" title="isString">isString</a></li>
<li class=""><a href="#method_isTrue" title="isTrue">isTrue</a></li>
<li class=""><a href="#method_isTypeOf" title="isTypeOf">isTypeOf</a></li>
<li class=""><a href="#method_isUndefined" title="isUndefined">isUndefined</a></li>
<li class=""><a href="#method_Y.assert" title="Y.assert">Y.assert</a></li>
<li class=""><a href="#method_Y.fail" title="Y.fail">Y.fail</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "", "host": "Assert", "name": "areEqual", "url": "Assert.html#method_areEqual", "type": "method"}, {"access": "", "host": "Assert", "name": "areNotEqual", "url": "Assert.html#method_areNotEqual", "type": "method"}, {"access": "", "host": "Assert", "name": "areNotSame", "url": "Assert.html#method_areNotSame", "type": "method"}, {"access": "", "host": "Assert", "name": "areSame", "url": "Assert.html#method_areSame", "type": "method"}, {"access": "private", "host": "Assert", "name": "_asserts", "url": "Assert.html#property__asserts", "type": "property"}, {"access": "", "host": "Assert", "name": "fail", "url": "Assert.html#method_fail", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_formatMessage", "url": "Assert.html#method__formatMessage", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_getCount", "url": "Assert.html#method__getCount", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_increment", "url": "Assert.html#method__increment", "type": "method"}, {"access": "", "host": "Assert", "name": "isArray", "url": "Assert.html#method_isArray", "type": "method"}, {"access": "", "host": "Assert", "name": "isBoolean", "url": "Assert.html#method_isBoolean", "type": "method"}, {"access": "", "host": "Assert", "name": "isFalse", "url": "Assert.html#method_isFalse", "type": "method"}, {"access": "", "host": "Assert", "name": "isFunction", "url": "Assert.html#method_isFunction", "type": "method"}, {"access": "", "host": "Assert", "name": "isInstanceOf", "url": "Assert.html#method_isInstanceOf", "type": "method"}, {"access": "", "host": "Assert", "name": "isNaN", "url": "Assert.html#method_isNaN", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotNaN", "url": "Assert.html#method_isNotNaN", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotNull", "url": "Assert.html#method_isNotNull", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotUndefined", "url": "Assert.html#method_isNotUndefined", "type": "method"}, {"access": "", "host": "Assert", "name": "isNull", "url": "Assert.html#method_isNull", "type": "method"}, {"access": "", "host": "Assert", "name": "isNumber", "url": "Assert.html#method_isNumber", "type": "method"}, {"access": "", "host": "Assert", "name": "isObject", "url": "Assert.html#method_isObject", "type": "method"}, {"access": "", "host": "Assert", "name": "isString", "url": "Assert.html#method_isString", "type": "method"}, {"access": "", "host": "Assert", "name": "isTrue", "url": "Assert.html#method_isTrue", "type": "method"}, {"access": "", "host": "Assert", "name": "isTypeOf", "url": "Assert.html#method_isTypeOf", "type": "method"}, {"access": "", "host": "Assert", "name": "isUndefined", "url": "Assert.html#method_isUndefined", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_reset", "url": "Assert.html#method__reset", "type": "method"}, {"access": "", "host": "Assert", "name": "Y.assert", "url": "Assert.html#method_Y.assert", "type": "method"}, {"access": "", "host": "Assert", "name": "Y.fail", "url": "Assert.html#method_Y.fail", "type": "method"}];
</script>
</body>
</html>