typescript-closure-tools/index/closure-library/closure/goog/testing/mockclock.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" />
/// <reference path="../disposable/disposable.d.ts" />

declare module goog.testing {

    class MockClock extends MockClock__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class MockClock__Class extends goog.Disposable__Class  { 
    
            /**
             * Class for unit testing code that uses setTimeout and clearTimeout.
             *
             * NOTE: If you are using MockClock to test code that makes use of
             *       goog.fx.Animation, then you must either:
             *
             * 1. Install and dispose of the MockClock in setUpPage() and tearDownPage()
             *    respectively (rather than setUp()/tearDown()).
             *
             * or
             *
             * 2. Ensure that every test clears the animation queue by calling
             *    mockClock.tick(x) at the end of each test function (where `x` is large
             *    enough to complete all animations).
             *
             * Otherwise, if any animation is left pending at the time that
             * MockClock.dispose() is called, that will permanently prevent any future
             * animations from playing on the page.
             *
             * @param {boolean=} opt_autoInstall Install the MockClock at construction time.
             * @constructor
             * @extends {goog.Disposable}
             * @final
             */
            constructor(opt_autoInstall?: boolean);
    
            /**
             * Installs the MockClock by overriding the global object's implementation of
             * setTimeout, setInterval, clearTimeout and clearInterval.
             */
            install(): void;
    
            /**
             * Removes the MockClock's hooks into the global object's functions and revert
             * to their original values.
             */
            uninstall(): void;
    
            /**
             * Resets the MockClock, removing all timeouts that are scheduled and resets
             * the fake timer count.
             */
            reset(): void;
    
            /**
             * Signals that the mock clock has been reset, allowing objects that
             * maintain their own internal state to reset.
             */
            fireResetEvent(): void;
    
            /**
             * Sets the amount of time between when a timeout is scheduled to fire and when
             * it actually fires.
             * @param {number} delay The delay in milliseconds.  May be negative.
             */
            setTimeoutDelay(delay: number): void;
    
            /**
             * @return {number} delay The amount of time between when a timeout is
             *     scheduled to fire and when it actually fires, in milliseconds.  May
             *     be negative.
             */
            getTimeoutDelay(): number;
    
            /**
             * Increments the MockClock's time by a given number of milliseconds, running
             * any functions that are now overdue.
             * @param {number=} opt_millis Number of milliseconds to increment the counter.
             *     If not specified, clock ticks 1 millisecond.
             * @return {number} Current mock time in milliseconds.
             */
            tick(opt_millis?: number): number;
    
            /**
             * @return {number} The number of timeouts that have been scheduled.
             */
            getTimeoutsMade(): number;
    
            /**
             * @return {number} The MockClock's current time in milliseconds.
             */
            getCurrentTime(): number;
    
            /**
             * @param {number} timeoutKey The timeout key.
             * @return {boolean} Whether the timer has been set and not cleared,
             *     independent of the timeout's expiration.  In other words, the timeout
             *     could have passed or could be scheduled for the future.  Either way,
             *     this function returns true or false depending only on whether the
             *     provided timeoutKey represents a timeout that has been set and not
             *     cleared.
             */
            isTimeoutSet(timeoutKey: number): boolean;
    } 
    
}

declare module goog.testing.MockClock {

    /**
     * Default wait timeout for mocking requestAnimationFrame (in milliseconds).
     *
     * @type {number}
     * @const
     */
    var REQUEST_ANIMATION_FRAME_TIMEOUT: number;
}