module-barejs.html 15 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: barejs</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">Module: barejs</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description"><p>The BareJS module is the entry point for accessing BareJS's classes and polyfills.</p></div>
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="bare.js.html">bare.js</a>, <a href="bare.js.html#line10">line 10</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Classes</h3>
  31. <dl>
  32. <dt><a href="module-barejs.decl.html">decl</a></dt>
  33. <dd></dd>
  34. <dt><a href="module-barejs.Destroyable.html">Destroyable</a></dt>
  35. <dd></dd>
  36. <dt><a href="module-barejs.EventArgs.html">EventArgs</a></dt>
  37. <dd></dd>
  38. <dt><a href="module-barejs.Evented.html">Evented</a></dt>
  39. <dd></dd>
  40. <dt><a href="module-barejs.Exception.html">Exception</a></dt>
  41. <dd></dd>
  42. </dl>
  43. <h3 class="subsection-title">Members</h3>
  44. <h4 class="name" id=".Intl"><span class="type-signature">(static) </span>Intl<span class="type-signature"> :function</span></h4>
  45. <div class="description">
  46. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl">Intl</a>
  47. or the fallback provided by BareJS. Note that BareJS's fallback just provides a similar API,
  48. it has not actual localization features. It's main purpose is to gracefully fallback to very limited formatting on
  49. environments that don't support Intl. For proper support, load a full Intl polyfill.</p>
  50. </div>
  51. <h5>Type:</h5>
  52. <ul>
  53. <li>
  54. <span class="param-type">function</span>
  55. </li>
  56. </ul>
  57. <dl class="details">
  58. <dt class="tag-source">Source:</dt>
  59. <dd class="tag-source"><ul class="dummy"><li>
  60. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line53">line 53</a>
  61. </li></ul></dd>
  62. </dl>
  63. <h4 class="name" id=".Map"><span class="type-signature">(static) </span>Map<span class="type-signature"> :function</span></h4>
  64. <div class="description">
  65. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map">Map</a>
  66. or the <a href="module-barejs_polyfill.Map.html">polyfill</a> provided by BareJS. This implementation is ensured to have iterator support (using the polyfill), if no
  67. iterator support is required it is better to use <a href="module-barejs.html#.NMap">NMap</a> instead.</p>
  68. </div>
  69. <h5>Type:</h5>
  70. <ul>
  71. <li>
  72. <span class="param-type">function</span>
  73. </li>
  74. </ul>
  75. <dl class="details">
  76. <dt class="tag-source">Source:</dt>
  77. <dd class="tag-source"><ul class="dummy"><li>
  78. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line61">line 61</a>
  79. </li></ul></dd>
  80. </dl>
  81. <h4 class="name" id=".NMap"><span class="type-signature">(static) </span>NMap<span class="type-signature"> :function</span></h4>
  82. <div class="description">
  83. <p>NMap - Version of Map that prefers the native implementation over the polyfill, even if it doesn't have
  84. iterator support (like in Internet Explorer 11). If Iterator support is required, use
  85. <a href="module-barejs.html#.Map">Map</a> instead.</p>
  86. </div>
  87. <h5>Type:</h5>
  88. <ul>
  89. <li>
  90. <span class="param-type">function</span>
  91. </li>
  92. </ul>
  93. <dl class="details">
  94. <dt class="tag-source">Source:</dt>
  95. <dd class="tag-source"><ul class="dummy"><li>
  96. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line34">line 34</a>
  97. </li></ul></dd>
  98. </dl>
  99. <h4 class="name" id=".NSet"><span class="type-signature">(static) </span>NSet<span class="type-signature"> :function</span></h4>
  100. <div class="description">
  101. <p>NSet - Version of Set that prefers the native implementation over the polyfill, even if it doesn't have
  102. iterator support (like in Internet Explorer 11). If Iterator support is required, use
  103. <a href="module-barejs.html#.Set">Set</a> instead.</p>
  104. </div>
  105. <h5>Type:</h5>
  106. <ul>
  107. <li>
  108. <span class="param-type">function</span>
  109. </li>
  110. </ul>
  111. <dl class="details">
  112. <dt class="tag-source">Source:</dt>
  113. <dd class="tag-source"><ul class="dummy"><li>
  114. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line42">line 42</a>
  115. </li></ul></dd>
  116. </dl>
  117. <h4 class="name" id=".Promise"><span class="type-signature">(static) </span>Promise<span class="type-signature"> :function</span></h4>
  118. <div class="description">
  119. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>
  120. or the <a href="module-barejs_polyfill.Promise.html">polyfill</a> provided by BareJS.</p>
  121. </div>
  122. <h5>Type:</h5>
  123. <ul>
  124. <li>
  125. <span class="param-type">function</span>
  126. </li>
  127. </ul>
  128. <dl class="details">
  129. <dt class="tag-source">Source:</dt>
  130. <dd class="tag-source"><ul class="dummy"><li>
  131. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line96">line 96</a>
  132. </li></ul></dd>
  133. </dl>
  134. <h4 class="name" id=".Set"><span class="type-signature">(static) </span>Set<span class="type-signature"> :function</span></h4>
  135. <div class="description">
  136. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set">Set</a>
  137. or the <a href="module-barejs_polyfill.Set.html">polyfill</a> provided by BareJS. This implementation is ensured to have iterator support (using the polyfill), if no
  138. iterator support is required it is better to use <a href="module-barejs.html#.NSet">NSet</a> instead.</p>
  139. </div>
  140. <h5>Type:</h5>
  141. <ul>
  142. <li>
  143. <span class="param-type">function</span>
  144. </li>
  145. </ul>
  146. <dl class="details">
  147. <dt class="tag-source">Source:</dt>
  148. <dd class="tag-source"><ul class="dummy"><li>
  149. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line76">line 76</a>
  150. </li></ul></dd>
  151. </dl>
  152. <h4 class="name" id=".Symbol"><span class="type-signature">(static) </span>Symbol<span class="type-signature"> :function</span></h4>
  153. <div class="description">
  154. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol">Symbol</a>
  155. or the <a href="module-barejs_polyfill.Symbol.html">polyfill</a> provided by BareJS.</p>
  156. </div>
  157. <h5>Type:</h5>
  158. <ul>
  159. <li>
  160. <span class="param-type">function</span>
  161. </li>
  162. </ul>
  163. <dl class="details">
  164. <dt class="tag-source">Source:</dt>
  165. <dd class="tag-source"><ul class="dummy"><li>
  166. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line89">line 89</a>
  167. </li></ul></dd>
  168. </dl>
  169. <h4 class="name" id=".WeakMap"><span class="type-signature">(static) </span>WeakMap<span class="type-signature"> :function</span></h4>
  170. <div class="description">
  171. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap">WeakMap</a>
  172. or the <a href="module-barejs_polyfill.WeakMap.html">polyfill</a> provided by BareJS.</p>
  173. </div>
  174. <h5>Type:</h5>
  175. <ul>
  176. <li>
  177. <span class="param-type">function</span>
  178. </li>
  179. </ul>
  180. <dl class="details">
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line68">line 68</a>
  184. </li></ul></dd>
  185. </dl>
  186. <h4 class="name" id=".WeakSet"><span class="type-signature">(static) </span>WeakSet<span class="type-signature"> :function</span></h4>
  187. <div class="description">
  188. <p>This is either the native <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet">WeakSet</a>
  189. or the <a href="module-barejs_polyfill.WeakSet.html">polyfill</a> provided by BareJS.</p>
  190. </div>
  191. <h5>Type:</h5>
  192. <ul>
  193. <li>
  194. <span class="param-type">function</span>
  195. </li>
  196. </ul>
  197. <dl class="details">
  198. <dt class="tag-source">Source:</dt>
  199. <dd class="tag-source"><ul class="dummy"><li>
  200. <a href="polyfill.js.html">polyfill.js</a>, <a href="polyfill.js.html#line82">line 82</a>
  201. </li></ul></dd>
  202. </dl>
  203. <h3 class="subsection-title">Methods</h3>
  204. <h4 class="name" id=".load"><span class="type-signature">(static) </span>load<span class="signature">()</span><span class="type-signature"></span></h4>
  205. <div class="description">
  206. <p>The BareJS module contains an AMD loader plugin to reference specific parts of BareJS directly.
  207. For example, this allows to require &quot;<a href="module-barejs.decl.html">barejs!decl</a>&quot;, &quot;<a href="module-barejs.html#.Promise">barejs!Promise</a>&quot;,
  208. &quot;<a href="module-barejs.html#.NMap">barejs!NMap</a>&quot; or &quot;<a href="module-barejs.html#.Map">barejs!Map</a>&quot;</p>
  209. </div>
  210. <dl class="details">
  211. <dt class="tag-source">Source:</dt>
  212. <dd class="tag-source"><ul class="dummy"><li>
  213. <a href="bare.js.html">bare.js</a>, <a href="bare.js.html#line31">line 31</a>
  214. </li></ul></dd>
  215. </dl>
  216. <h4 class="name" id=".write"><span class="type-signature">(static) </span>write<span class="signature">()</span><span class="type-signature"></span></h4>
  217. <div class="description">
  218. <p>While we want to provide the plugin shortcut to objects, we don't want to build this into a layer.</p>
  219. </div>
  220. <dl class="details">
  221. <dt class="tag-source">Source:</dt>
  222. <dd class="tag-source"><ul class="dummy"><li>
  223. <a href="bare.js.html">bare.js</a>, <a href="bare.js.html#line42">line 42</a>
  224. </li></ul></dd>
  225. </dl>
  226. </article>
  227. </section>
  228. </div>
  229. <nav>
  230. <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>
  231. </nav>
  232. <br class="clear">
  233. <footer>
  234. 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)
  235. </footer>
  236. <script> prettyPrint(); </script>
  237. <script src="scripts/linenumber.js"> </script>
  238. </body>
  239. </html>