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 /**
  29  * @interface
  30  */
  31 QUnit.Assert = function() {};
  32
  33 /**
  34  * @return {function():void}
  35  */
  36 QUnit.Assert.prototype.async = function() {};
  37
  38 /**
  39  * @param {*} a
  40  * @param {*} b
  41  * @param {string=} opt_desc
  42  */
  43 QUnit.Assert.prototype.notEqual = function(a, b, opt_desc) {};
  44
  45 /**
  46  * @param {*} cond Passes if cond is truthy.
  47  * @param {string=} desc
  48  * @return {boolean}
  49  */
  50 QUnit.Assert.prototype.ok = function(cond, desc) {};
  51
  52 /**
  53  * @param {*} a
  54  * @param {*} b
  55  * @param {string=} opt_message
  56  */
  57 QUnit.Assert.prototype.deepEqual = function(a, b, opt_message) {};
  58
  59 /**
  60  * @param {*} a
  61  * @param {*} b
  62  * @param {string=} opt_message
  63  */
  64 QUnit.Assert.prototype.equal = function(a, b, opt_message) {};
  65
  66 /**
  67  * @param {number} assertionCount
  68  */
  69 QUnit.Assert.prototype.expect = function(assertionCount) {};
  70
  71 /**
  72  * @param {*} a
  73  * @param {*} b
  74  * @param {string=} opt_message
  75  */
  76 QUnit.Assert.prototype.strictEqual = function(a, b, opt_message) {};
  77
  78 /**
  79  * @param {function()} a
  80  * @param {*=} opt_b
  81  * @param {string=} opt_message
  82  */
  83 QUnit.Assert.prototype.throws = function(a, opt_b, opt_message) {};
  84
  85 /**
  86  * @typedef {{
  87  *   beforeEach: (function(!QUnit.Assert) | undefined),
  88  *   afterEach: (function(!QUnit.Assert) | undefined)
  89  * }}
  90  */
  91 QUnit.ModuleArgs;
  92
  93 /**
  94  * @param {string} desc
  95  * @param {QUnit.ModuleArgs=} opt_args=
  96  */
  97 QUnit.module = function(desc, opt_args) {};
  98
  99 /**
 100  * @param {string} desc
 101  * @param {function(!QUnit.Assert)} f
 102  */
 103 QUnit.test = function(desc, f) {};