remoting/webapp/js_proto/sinon_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 var sinon = sinon || {};
   6
   7 /** @type {Object} */
   8 sinon.assert = {};
   9
  10 /**
  11  * @param {(sinon.Spy|Function)} f
  12  */
  13 sinon.assert.called = function(f) {};
  14
  15 /**
  16  * @param {(sinon.Spy|Function)} f
  17  */
  18 sinon.assert.calledOnce = function(f) {};
  19
  20 /**
  21  * @param {(sinon.Spy|Function)} f
  22  * @param {...} data
  23  */
  24 sinon.assert.calledWith = function(f, data) {};
  25
  26 /**
  27  * @param {(sinon.Spy|Function)} f
  28  */
  29 sinon.assert.notCalled = function(f) {};
  30
  31 /** @constructor */
  32 sinon.Clock = function() {};
  33
  34 /** @param {number} ms */
  35 sinon.Clock.prototype.tick = function(ms) {};
  36
  37 /** @return {void} */
  38 sinon.Clock.prototype.restore = function() {};
  39
  40 /**
  41  * @param {number=} opt_now
  42  * @return {sinon.Clock}
  43  */
  44 sinon.useFakeTimers = function(opt_now) {};
  45
  46 /** @constructor */
  47 sinon.Expectation = function() {};
  48
  49 /** @return {sinon.Expectation} */
  50 sinon.Expectation.prototype.once = function() {};
  51
  52 /** @return {sinon.Expectation} */
  53 sinon.Expectation.prototype.never = function() {};
  54
  55 /**
  56  * @param {number} times
  57  * @return {sinon.Expectation}
  58  */
  59 sinon.Expectation.prototype.exactly = function(times) {};
  60
  61 /**
  62  * @param {...} data
  63  * @return {sinon.Expectation}
  64  */
  65 sinon.Expectation.prototype.withArgs = function(data) {};
  66
  67 /** @return {boolean} */
  68 sinon.Expectation.prototype.verify = function() {};
  69
  70 /** @param {...} data */
  71 sinon.Expectation.prototype.returns = function(data) {};
  72
  73 /**
  74  * @param {Object} obj
  75  * @return {sinon.Mock}
  76  */
  77 sinon.mock = function(obj) {};
  78
  79 /** @constructor */
  80 sinon.Mock = function() {};
  81
  82 /**
  83  * @param {string} method
  84  * @return {sinon.Expectation}
  85  */
  86 sinon.Mock.prototype.expects = function(method) {};
  87
  88 /**
  89  * @return {void}
  90  */
  91 sinon.Mock.prototype.restore = function() {};
  92
  93 /**
  94  * @return {boolean}
  95  */
  96 sinon.Mock.prototype.verify = function() {};
  97
  98 /** @type {function(...):Function} */
  99 sinon.spy = function() {};
 100
 101 /**
 102  * This is a jscompile type that can be OR'ed with the actual type to make
 103  * jscompile aware of the sinon.spy functions that are added to the base
 104  * type.
 105  * Example: Instead of specifying a type of
 106  *   {function():void}
 107  * the following can be used to add the sinon.spy functions:
 108  *   {(sinon.Spy|function():void)}
 109  *
 110  * @interface
 111  */
 112 sinon.Spy = function() {};
 113
 114 /** @type {number} */
 115 sinon.Spy.prototype.callCount;
 116
 117 /** @type {boolean} */
 118 sinon.Spy.prototype.called;
 119
 120 /** @type {boolean} */
 121 sinon.Spy.prototype.calledOnce;
 122
 123 /** @type {boolean} */
 124 sinon.Spy.prototype.calledTwice;
 125
 126 /** @type {function(...):boolean} */
 127 sinon.Spy.prototype.calledWith = function() {};
 128
 129 /** @type {function(number):{args:Array}} */
 130 sinon.Spy.prototype.getCall = function(index) {};
 131
 132 sinon.Spy.prototype.reset = function() {};
 133
 134 sinon.Spy.prototype.restore = function() {};
 135
 136 /** @type {Array<Array<*>>} */
 137 sinon.Spy.prototype.args;
 138
 139 /**
 140  * @param {Object=} opt_obj
 141  * @param {string=} opt_method
 142  * @param {Function=} opt_stubFunction
 143  * @return {sinon.TestStub}
 144  */
 145 sinon.stub = function(opt_obj, opt_method, opt_stubFunction) {};
 146
 147 /**
 148 * TODO(jrw): rename to |sinon.Stub| for consistency
 149  * @interface
 150  * @extends {sinon.Spy}
 151  */
 152 sinon.TestStub = function() {};
 153
 154 /** @type {function(number):{args:Array}} */
 155 sinon.TestStub.prototype.getCall = function(index) {};
 156
 157 sinon.TestStub.prototype.restore = function() {};
 158
 159 /** @param {*} a */
 160 sinon.TestStub.prototype.returns = function(a) {};
 161
 162 /** @type {function(...):sinon.Expectation} */
 163 sinon.TestStub.prototype.withArgs = function() {};
 164
 165 /** @type {function(...):sinon.Expectation} */
 166 sinon.TestStub.prototype.onFirstCall = function() {};
 167
 168 /** @type {function(...):sinon.Expectation} */
 169 sinon.TestStub.prototype.callsArgWith = function() {};
 170
 171 /** @returns {Object}  */
 172 sinon.createStubInstance = function (/** * */ constructor) {};
 173
 174 /** @interface */
 175 sinon.FakeXhrCtrl = function() {};
 176
 177 /**
 178  * @type {?function(!sinon.FakeXhr)}
 179  */
 180 sinon.FakeXhrCtrl.prototype.onCreate;
 181
 182 /**
 183  * @type {function():void}
 184  */
 185 sinon.FakeXhrCtrl.prototype.restore;
 186
 187 /** @return {sinon.FakeXhrCtrl} */
 188 sinon.useFakeXMLHttpRequest = function() {};
 189
 190 /** @interface */
 191 sinon.FakeXhr = function() {};
 192
 193 /** @type {number} */
 194 sinon.FakeXhr.prototype.readyState;
 195
 196 /** @type {string} */
 197 sinon.FakeXhr.prototype.method;
 198
 199 /** @type {string} */
 200 sinon.FakeXhr.prototype.url;
 201
 202 /** @type {boolean} */
 203 sinon.FakeXhr.prototype.withCredentials;
 204
 205 /** @type {?string} */
 206 sinon.FakeXhr.prototype.requestBody;
 207
 208 /** @type {!Object<string>} */
 209 sinon.FakeXhr.prototype.requestHeaders;
 210
 211 /**
 212  * @param {number} status
 213  * @param {!Object<string>} headers
 214  * @param {?string} content
 215  */
 216 sinon.FakeXhr.prototype.respond;
 217
 218 /**
 219  * @param {string} event
 220  * @param {Function} handler
 221  */
 222 sinon.FakeXhr.prototype.addEventListener;