# Yahoo! UI Library

### test 3.0.0b1

Yahoo! UI Library > test > Assert
Search:
Filters Show Private Show Protected Show Deprecated

## `static` Class Assert

The Assert object provides functions to test JavaScript values against known and expected results. Whenever a comparison (assertion) fails, an error is thrown.

### Properties

#### _asserts - `private int`

The number of assertions performed.

### Methods

#### _formatMessage

`protected static String _formatMessage ( customMessage , defaultMessage )`
Formats a message so that it can contain the original assertion message in addition to the custom message.

Parameters:
  `customMessage <String>` The message passed in by the developer.
  `defaultMessage <String>` The message created by the error by default.

Returns: `String`
  The final error message, containing either or both.

#### _getCount

`protected static void _getCount ( )`
Returns the number of assertions that have been performed.

Returns: `void`

#### _increment

`protected static void _increment ( )`
Increments the number of assertions that have been performed.

Returns: `void`

#### _reset

`protected static void _reset ( )`
Resets the number of assertions that have been performed to 0.

Returns: `void`

#### areEqual

`static void areEqual ( expected , actual , message )`
Asserts that a value is equal to another. This uses the double equals sign so type cohersion may occur.

Parameters:
  `expected <Object>` The expected value.
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### areNotEqual

`static void areNotEqual ( unexpected , actual , message )`
Asserts that a value is not equal to another. This uses the double equals sign so type cohersion may occur.

Parameters:
  `unexpected <Object>` The unexpected value.
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### areNotSame

`static void areNotSame ( unexpected , actual , message )`
Asserts that a value is not the same as another. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `unexpected <Object>` The unexpected value.
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### areSame

`static void areSame ( expected , actual , message )`
Asserts that a value is the same as another. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `expected <Object>` The expected value.
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### fail

`static void fail ( message )`
Forces an assertion error to occur.

Parameters:
  `message <String>` (Optional) The message to display with the failure.

Returns: `void`

#### isArray

`static void isArray ( actual , message )`
Asserts that a value is an array.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isBoolean

`static void isBoolean ( actual , message )`
Asserts that a value is a Boolean.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isFalse

`static void isFalse ( actual , message )`
Asserts that a value is false. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isFunction

`static void isFunction ( actual , message )`
Asserts that a value is a function.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isInstanceOf

`static void isInstanceOf ( expected , actual , message )`
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.

Parameters:
  `expected <Function>` The function that the object should be an instance of.
  `actual <Object>` The object to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNaN

`static void isNaN ( actual , message )`
Asserts that a value is not a number.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNotNaN

`static void isNotNaN ( actual , message )`
Asserts that a value is not the special NaN value.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNotNull

`static void isNotNull ( actual , message )`
Asserts that a value is not null. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNotUndefined

`static void isNotUndefined ( actual , message )`
Asserts that a value is not undefined. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNull

`static void isNull ( actual , message )`
Asserts that a value is null. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isNumber

`static void isNumber ( actual , message )`
Asserts that a value is a number.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isObject

`static void isObject ( actual , message )`
Asserts that a value is an object.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isString

`static void isString ( actual , message )`
Asserts that a value is a string.

Parameters:
  `actual <Object>` The value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isTrue

`static void isTrue ( actual , message )`
Asserts that a value is true. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isTypeOf

`static void isTypeOf ( expectedType , actualValue , message )`
Asserts that a value is of a particular type.

Parameters:
  `expectedType <String>` The expected type of the variable.
  `actualValue <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### isUndefined

`static void isUndefined ( actual , message )`
Asserts that a value is undefined. This uses the triple equals sign so no type cohersion may occur.

Parameters:
  `actual <Object>` The actual value to test.
  `message <String>` (Optional) The message to display if the assertion fails.

Returns: `void`

#### Y.assert

`static void Y.assert ( condition , message )`
Asserts that a given condition is true. If not, then a Y.Assert.Error object is thrown and the test fails.

Parameters:
  `condition <Boolean>` The condition to test.
  `message <String>` The message to display if the assertion fails.

Returns: `void`

#### Y.fail

`static void Y.fail ( message )`
Forces an assertion error to occur. Shortcut for Y.Assert.fail().

Parameters:
  `message <String>` (Optional) The message to display with the failure.

Returns: `void`

Copyright © 2009 Yahoo! Inc. All rights reserved.