module-barejs_polyfill.Promise.html 14 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Promise</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Promise</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>
  20. <span class="ancestors"><a href="module-barejs_polyfill.html">barejs/polyfill</a>.</span>Promise<span class="signature">(_resolver)</span><span class="type-signature"></span></h2>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h4 class="name" id="Promise"><span class="type-signature"></span>new Promise<span class="signature">(_resolver)</span><span class="type-signature"></span></h4>
  25. <div class="description">
  26. <p>Create a new Promise</p>
  27. </div>
  28. <h5>Parameters:</h5>
  29. <table class="params">
  30. <thead>
  31. <tr>
  32. <th>Name</th>
  33. <th>Type</th>
  34. <th class="last">Description</th>
  35. </tr>
  36. </thead>
  37. <tbody>
  38. <tr>
  39. <td class="name"><code>_resolver</code></td>
  40. <td class="type">
  41. <span class="param-type">function</span>
  42. </td>
  43. <td class="description last"><p>The resolver function that will be called with two callbacks:
  44. _resolve (call on succes) and _reject (call on failure).</p></td>
  45. </tr>
  46. </tbody>
  47. </table>
  48. <dl class="details">
  49. <dt class="tag-source">Source:</dt>
  50. <dd class="tag-source"><ul class="dummy"><li>
  51. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line137">line 137</a>
  52. </li></ul></dd>
  53. </dl>
  54. </div>
  55. <h3 class="subsection-title">Methods</h3>
  56. <h4 class="name" id=".all"><span class="type-signature">(static) </span>all<span class="signature">(_iterable)</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  57. <div class="description">
  58. <p>The Promise.all( _iterable ) method returns a promise that resolves when all of the promises
  59. in the iterable argument have resolved. If any of the passed in promises rejects, the all
  60. Promise immediately rejects with the value of the promise that rejected, discarding all the
  61. other promises whether or not they have resolved.</p>
  62. </div>
  63. <h5>Parameters:</h5>
  64. <table class="params">
  65. <thead>
  66. <tr>
  67. <th>Name</th>
  68. <th>Type</th>
  69. <th class="last">Description</th>
  70. </tr>
  71. </thead>
  72. <tbody>
  73. <tr>
  74. <td class="name"><code>_iterable</code></td>
  75. <td class="type">
  76. <span class="param-type">Object</span>
  77. </td>
  78. <td class="description last"><p>Array that can be iterated.</p></td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. <dl class="details">
  83. <dt class="tag-source">Source:</dt>
  84. <dd class="tag-source"><ul class="dummy"><li>
  85. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line325">line 325</a>
  86. </li></ul></dd>
  87. </dl>
  88. <h5>Returns:</h5>
  89. <div class="param-desc">
  90. <p>A promise that will resolve with an array of values corresponding to all Promises in _iterable, after every Promise is resolved.</p>
  91. </div>
  92. <dl>
  93. <dt>
  94. Type
  95. </dt>
  96. <dd>
  97. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  98. </dd>
  99. </dl>
  100. <h4 class="name" id=".race"><span class="type-signature">(static) </span>race<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  101. <div class="description">
  102. <p>The Promise.race( _iterable ) method returns a promise that resolves or rejects as soon as one
  103. of the promises in the iterable resolves or rejects, with the value or reason from that promise.</p>
  104. </div>
  105. <dl class="details">
  106. <dt class="tag-source">Source:</dt>
  107. <dd class="tag-source"><ul class="dummy"><li>
  108. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line371">line 371</a>
  109. </li></ul></dd>
  110. </dl>
  111. <h5>Returns:</h5>
  112. <div class="param-desc">
  113. <p>A promise that will resolve with the value of the first Promise to resolve.</p>
  114. </div>
  115. <dl>
  116. <dt>
  117. Type
  118. </dt>
  119. <dd>
  120. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  121. </dd>
  122. </dl>
  123. <h4 class="name" id=".reject"><span class="type-signature">(static) </span>reject<span class="signature">(_reason)</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  124. <div class="description">
  125. <p>The Promise.reject( _reason ) method returns a Promise object that is rejected with the given reason.</p>
  126. </div>
  127. <h5>Parameters:</h5>
  128. <table class="params">
  129. <thead>
  130. <tr>
  131. <th>Name</th>
  132. <th>Type</th>
  133. <th class="last">Description</th>
  134. </tr>
  135. </thead>
  136. <tbody>
  137. <tr>
  138. <td class="name"><code>_reason</code></td>
  139. <td class="type">
  140. <span class="param-type">*</span>
  141. </td>
  142. <td class="description last"><p>The rejection reason (passed as rejection argument).</p></td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <dl class="details">
  147. <dt class="tag-source">Source:</dt>
  148. <dd class="tag-source"><ul class="dummy"><li>
  149. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line309">line 309</a>
  150. </li></ul></dd>
  151. </dl>
  152. <h5>Returns:</h5>
  153. <div class="param-desc">
  154. <p>A Promise that is rejected with _reason.</p>
  155. </div>
  156. <dl>
  157. <dt>
  158. Type
  159. </dt>
  160. <dd>
  161. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  162. </dd>
  163. </dl>
  164. <h4 class="name" id=".resolve"><span class="type-signature">(static) </span>resolve<span class="signature">(_value)</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  165. <div class="description">
  166. <p>The Promise.resolve( _value ) method returns a Promise object that is resolved with the given value.
  167. If the value is a thenable (i.e. has a then method), the returned promise will &quot;follow&quot; that thenable,
  168. adopting its eventual state; otherwise the returned promise will be fulfilled with the value.</p>
  169. </div>
  170. <h5>Parameters:</h5>
  171. <table class="params">
  172. <thead>
  173. <tr>
  174. <th>Name</th>
  175. <th>Type</th>
  176. <th class="last">Description</th>
  177. </tr>
  178. </thead>
  179. <tbody>
  180. <tr>
  181. <td class="name"><code>_value</code></td>
  182. <td class="type">
  183. <span class="param-type">*</span>
  184. </td>
  185. <td class="description last"><p>The value to resolve with.</p></td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <dl class="details">
  190. <dt class="tag-source">Source:</dt>
  191. <dd class="tag-source"><ul class="dummy"><li>
  192. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line296">line 296</a>
  193. </li></ul></dd>
  194. </dl>
  195. <h5>Returns:</h5>
  196. <div class="param-desc">
  197. <p>A Promise that is resolved with _value.</p>
  198. </div>
  199. <dl>
  200. <dt>
  201. Type
  202. </dt>
  203. <dd>
  204. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  205. </dd>
  206. </dl>
  207. <h4 class="name" id="catch"><span class="type-signature"></span>catch<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  208. <div class="description">
  209. <p>Register a rejection callback (shortcut for then( null, _onRejected ) ).</p>
  210. </div>
  211. <dl class="details">
  212. <dt class="tag-source">Source:</dt>
  213. <dd class="tag-source"><ul class="dummy"><li>
  214. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line422">line 422</a>
  215. </li></ul></dd>
  216. </dl>
  217. <h5>Returns:</h5>
  218. <div class="param-desc">
  219. <p>A promise that will resolve or reject with the value returned by (or thrown from) _onRejected.</p>
  220. </div>
  221. <dl>
  222. <dt>
  223. Type
  224. </dt>
  225. <dd>
  226. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  227. </dd>
  228. </dl>
  229. <h4 class="name" id="then"><span class="type-signature"></span>then<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a>}</span></h4>
  230. <div class="description">
  231. <p>Register either a resolve or reject callback, or both.</p>
  232. </div>
  233. <dl class="details">
  234. <dt class="tag-source">Source:</dt>
  235. <dd class="tag-source"><ul class="dummy"><li>
  236. <a href="polyfill_Promise.js.html">polyfill/Promise.js</a>, <a href="polyfill_Promise.js.html#line408">line 408</a>
  237. </li></ul></dd>
  238. </dl>
  239. <h5>Returns:</h5>
  240. <div class="param-desc">
  241. <p>A promise that will resolve or reject with the value returned by (or thrown from) _onFulfilled or _onRejected.</p>
  242. </div>
  243. <dl>
  244. <dt>
  245. Type
  246. </dt>
  247. <dd>
  248. <span class="param-type"><a href="module-barejs_polyfill.Promise.html">module:barejs/polyfill.Promise</a></span>
  249. </dd>
  250. </dl>
  251. </article>
  252. </section>
  253. </div>
  254. <nav>
  255. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-barejs.html">barejs</a></li><li><a href="module-barejs_polyfill.html">barejs/polyfill</a></li><li><a href="module-barejs_polyfill_Intl.html">barejs/polyfill/Intl</a></li></ul><h3>Classes</h3><ul><li><a href="module-barejs.decl.html">decl</a></li><li><a href="module-barejs.decl-Enum.html">Enum</a></li><li><a href="module-barejs.decl-Interface.html">Interface</a></li><li><a href="module-barejs.decl-SpecialType.html">SpecialType</a></li><li><a href="module-barejs.Destroyable.html">Destroyable</a></li><li><a href="module-barejs.EventArgs.html">EventArgs</a></li><li><a href="module-barejs.Evented.html">Evented</a></li><li><a href="module-barejs.Evented-EventedHandle.html">EventedHandle</a></li><li><a href="module-barejs.Exception.html">Exception</a></li><li><a href="module-barejs_polyfill.Array.html">Array</a></li><li><a href="module-barejs_polyfill.Date.html">Date</a></li><li><a href="module-barejs_polyfill.EntryStore.html">EntryStore</a></li><li><a href="module-barejs_polyfill.EntryStore.Iterator.html">Iterator</a></li><li><a href="module-barejs_polyfill.Function.html">Function</a></li><li><a href="module-barejs_polyfill.Map.html">Map</a></li><li><a href="module-barejs_polyfill.Map-MapIterator.html">MapIterator</a></li><li><a href="module-barejs_polyfill.Math.html">Math</a></li><li><a href="module-barejs_polyfill.Number.html">Number</a></li><li><a href="module-barejs_polyfill.Object.html">Object</a></li><li><a href="module-barejs_polyfill.Promise.html">Promise</a></li><li><a href="module-barejs_polyfill.Set.html">Set</a></li><li><a href="module-barejs_polyfill.Set-SetIterator.html">SetIterator</a></li><li><a href="module-barejs_polyfill.String.html">String</a></li><li><a href="module-barejs_polyfill.Symbol.html">Symbol</a></li><li><a href="module-barejs_polyfill.WeakMap.html">WeakMap</a></li><li><a href="module-barejs_polyfill.WeakSet.html">WeakSet</a></li><li><a href="module-barejs_polyfill_Intl.DateTimeFormat.html">DateTimeFormat</a></li><li><a href="module-barejs_polyfill_Intl.DateTimeFormat-DateTimeFormatOptions.html">DateTimeFormatOptions</a></li><li><a href="module-barejs_polyfill_Intl.NumberFormat.html">NumberFormat</a></li><li><a href="module-barejs_polyfill_Intl.NumberFormat-NumberFormatOptions.html">NumberFormatOptions</a></li><li><a href="module-barejs_polyfill_Intl-Format.html">Format</a></li></ul>
  256. </nav>
  257. <br class="clear">
  258. <footer>
  259. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Oct 03 2018 15:59:34 GMT+0200 (W. Europe Daylight Time)
  260. </footer>
  261. <script> prettyPrint(); </script>
  262. <script src="scripts/linenumber.js"> </script>
  263. </body>
  264. </html>