typescript-closure-tools/index/closure-library/closure/goog/testing/asserts.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />

declare module goog.testing {

    class JsUnitException extends JsUnitException__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class JsUnitException__Class extends _Error  { 
    
            /**
             * @param {string} comment A summary for the exception.
             * @param {?string=} opt_message A description of the exception.
             * @constructor
             * @extends {Error}
             * @final
             */
            constructor(comment: string, opt_message?: string);
    } 
    
}

declare module goog.testing.asserts {

    /**
     * @typedef {Array|NodeList|Arguments|{length: number}}
     */
    type ArrayLike = any[]|NodeList|Arguments|{ length: number };

    /**
     * Runs a function in an environment where test failures are not logged. This is
     * useful for testing test code, where failures can be a normal part of a test.
     * @param {function() : void} fn Function to run without logging failures.
     */
    function callWithoutLogging(fn: { (): void }): void;

    /**
     * The return value of the equality predicate passed to findDifferences below,
     * in cases where the predicate can't test the input variables for equality.
     * @type {?string}
     */
    var EQUALITY_PREDICATE_CANT_PROCESS: string;

    /**
     * The return value of the equality predicate passed to findDifferences below,
     * in cases where the input vriables are equal.
     * @type {?string}
     */
    var EQUALITY_PREDICATE_VARS_ARE_EQUAL: string;

    /**
     * Determines if two items of any type match, and formulates an error message
     * if not.
     * @param {*} expected Expected argument to match.
     * @param {*} actual Argument as a result of performing the test.
     * @param {(function(string, *, *): ?string)=} opt_equalityPredicate An optional
     *     function that can be used to check equality of variables. It accepts 3
     *     arguments: type-of-variables, var1, var2 (in that order) and returns an
     *     error message if the variables are not equal,
     *     goog.testing.asserts.EQUALITY_PREDICATE_VARS_ARE_EQUAL if the variables
     *     are equal, or
     *     goog.testing.asserts.EQUALITY_PREDICATE_CANT_PROCESS if the predicate
     *     couldn't check the input variables. The function will be called only if
     *     the types of var1 and var2 are identical.
     * @return {?string} Null on success, error message on failure.
     */
    function findDifferences(expected: any, actual: any, opt_equalityPredicate?: { (_0: string, _1: any, _2: any): string }): string;

    /**
     * Raises a JsUnit exception with the given comment.
     * @param {string} comment A summary for the exception.
     * @param {string=} opt_message A description of the exception.
     */
    function raiseException(comment: string, opt_message?: string): void;
}