Version 3.18.1
Show:

Test.Assert Class

Defined in: test/js/Assert.js:2
Module: test

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

Item Index

Methods

Properties

Methods

_formatMessage

(
  • customMessage
  • defaultMessage
)
String protected static

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

Returns the number of assertions that have been performed.

_increment

() protected static

Increments the number of assertions that have been performed.

_reset

() protected static

Resets the number of assertions that have been performed to 0.

areEqual

(
  • expected
  • actual
  • message
)
static

Asserts that a value is equal to another. This uses the double equals sign so type coercion 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.

areNotEqual

(
  • unexpected
  • actual
  • message
)
static

Asserts that a value is not equal to another. This uses the double equals sign so type coercion 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.

areNotSame

(
  • unexpected
  • actual
  • message
)
static

Asserts that a value is not the same as another. This uses the triple equals sign so no type coercion 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.

areSame

(
  • expected
  • actual
  • message
)
static

Asserts that a value is the same as another. This uses the triple equals sign so no type coercion 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.

fail

(
  • message
)
static

Forces an assertion error to occur.

Parameters:

  • message String

    (Optional) The message to display with the failure.

isArray

(
  • actual
  • message
)
static

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.

isBoolean

(
  • actual
  • message
)
static

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.

isFalse

(
  • actual
  • message
)
static

Asserts that a value is false. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

isFunction

(
  • actual
  • message
)
static

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.

isInstanceOf

(
  • expected
  • actual
  • message
)
static

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.

isNaN

(
  • actual
  • message
)
static

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.

isNotNaN

(
  • actual
  • message
)
static

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.

isNotNull

(
  • actual
  • message
)
static

Asserts that a value is not null. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

isNotUndefined

(
  • actual
  • message
)
static

Asserts that a value is not undefined. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

isNull

(
  • actual
  • message
)
static

Asserts that a value is null. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

isNumber

(
  • actual
  • message
)
static

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.

isObject

(
  • actual
  • message
)
static

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.

isString

(
  • actual
  • message
)
static

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.

isTrue

(
  • actual
  • message
)
static

Asserts that a value is true. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

isTypeOf

(
  • expectedType
  • actualValue
  • message
)
static

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.

isUndefined

(
  • actual
  • message
)
static

Asserts that a value is undefined. This uses the triple equals sign so no type coercion may occur.

Parameters:

  • actual Object

    The actual value to test.

  • message String

    (Optional) The message to display if the assertion fails.

pass

() static

A marker that the test should pass.

throwsError

(
  • expectedError
  • method
  • message
)
static

Asserts that executing a particular method should throw an error of a specific type. This is a replacement for _should.error.

Parameters:

  • expectedError String | Function | Object

    If a string, this is the error message that the error must have; if a function, this is the constructor that should have been used to create the thrown error; if an object, this is an instance of a particular error type with a specific error message (both must match).

  • method Function

    The method to execute that should throw the error.

  • message String

    (Optional) The message to display if the assertion fails.

Properties

_asserts

Int private

The number of assertions performed.