remoting/webapp/js_proto/qunit_proto.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // This file contains various hacks needed to inform JSCompiler of various
   6 // QUnit-specific properties and methods. It is used only with JSCompiler to
   7 // verify the type-correctness of our code.
   8
   9
  10 /** @type {Object} */
  11 var QUnit = QUnit || {};
  12
  13 /** @constructor */
  14 QUnit.Test = function() {};
  15
  16 /** @type {QUnit.Clock} */
  17 QUnit.Test.prototype.clock = new QUnit.Clock();
  18
  19 /** @constructor */
  20 QUnit.Clock = function() {};
  21
  22 /** @param {number} ticks */
  23 QUnit.Clock.prototype.tick = function(ticks) {};
  24
  25 /** @param {Function} f */
  26 QUnit.testStart = function(f) {};
  27
  28 /** @param {Function} f */
  29 QUnit.testDone = function(f) {};
  30 /**
  31  * @interface
  32  */
  33 QUnit.Assert = function() {};
  34
  35 /**
  36  * @return {function():void}
  37  */
  38 QUnit.Assert.prototype.async = function() {};
  39
  40 /**
  41  * @param {*} a
  42  * @param {*} b
  43  * @param {string=} opt_desc
  44  */
  45 QUnit.Assert.prototype.notEqual = function(a, b, opt_desc) {};
  46
  47 /**
  48  * @param {*} cond Passes if cond is truthy.
  49  * @param {string=} desc
  50  * @return {boolean}
  51  */
  52 QUnit.Assert.prototype.ok = function(cond, desc) {};
  53
  54 /**
  55  * @param {*} a
  56  * @param {*} b
  57  * @param {string=} opt_message
  58  */
  59 QUnit.Assert.prototype.deepEqual = function(a, b, opt_message) {};
  60
  61 /**
  62  * @param {*} a
  63  * @param {*} b
  64  * @param {string=} opt_message
  65  */
  66 QUnit.Assert.prototype.equal = function(a, b, opt_message) {};
  67
  68 /**
  69  * @param {number} assertionCount
  70  */
  71 QUnit.Assert.prototype.expect = function(assertionCount) {};
  72
  73 /**
  74  * @param {*} a
  75  * @param {*} b
  76  * @param {string=} opt_message
  77  */
  78 QUnit.Assert.prototype.strictEqual = function(a, b, opt_message) {};
  79
  80 /**
  81  * @param {function()} a
  82  * @param {*=} opt_b
  83  * @param {string=} opt_message
  84  */
  85 QUnit.Assert.prototype.throws = function(a, opt_b, opt_message) {};
  86
  87 /**
  88  * @typedef {{
  89  *   beforeEach: (function(!QUnit.Assert) | undefined),
  90  *   afterEach: (function(!QUnit.Assert) | undefined)
  91  * }}
  92  */
  93 QUnit.ModuleArgs;
  94
  95 /**
  96  * @param {string} desc
  97  * @param {QUnit.ModuleArgs=} opt_args=
  98  */
  99 QUnit.module = function(desc, opt_args) {};
 100
 101 /**
 102  * @param {string} desc
 103  * @param {function(!QUnit.Assert)} f
 104  */
 105 QUnit.test = function(desc, f) {};
 106
 107 /**
 108  * @param {string} desc
 109  * @param {function(!QUnit.Assert)} f
 110  */
 111 QUnit.skip = function(desc, f) {};