module-barejs_polyfill_Intl.DateTimeFormat.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: DateTimeFormat</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: DateTimeFormat</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_Intl.html">barejs/polyfill/Intl</a>.</span>DateTimeFormat<span class="signature">()</span><span class="type-signature"></span></h2>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h4 class="name" id="DateTimeFormat"><span class="type-signature"></span>new DateTimeFormat<span class="signature">()</span><span class="type-signature"></span></h4>
  25. <div class="description">
  26. <p>Provides Date/Time formatting</p>
  27. </div>
  28. <dl class="details">
  29. <dt class="tag-source">Source:</dt>
  30. <dd class="tag-source"><ul class="dummy"><li>
  31. <a href="polyfill_Intl_DateTimeFormat.js.html">polyfill/Intl/DateTimeFormat.js</a>, <a href="polyfill_Intl_DateTimeFormat.js.html#line267">line 267</a>
  32. </li></ul></dd>
  33. </dl>
  34. </div>
  35. <h3 class="subsection-title">Extends</h3>
  36. <ul>
  37. <li><a href="module-barejs_polyfill_Intl-Format.html">module:barejs/polyfill/Intl~Format</a></li>
  38. </ul>
  39. <h3 class="subsection-title">Classes</h3>
  40. <dl>
  41. <dt><a href="module-barejs_polyfill_Intl.DateTimeFormat-DateTimeFormatOptions.html">DateTimeFormatOptions</a></dt>
  42. <dd></dd>
  43. </dl>
  44. <h3 class="subsection-title">Members</h3>
  45. <h4 class="name" id="format"><span class="type-signature"></span>format<span class="type-signature"></span></h4>
  46. <div class="description">
  47. <p>Format a value</p>
  48. </div>
  49. <dl class="details">
  50. <dt class="tag-overrides">Overrides:</dt>
  51. <dd class="tag-overrides"><ul class="dummy"><li>
  52. <a href="module-barejs_polyfill_Intl-Format.html#format">module:barejs/polyfill/Intl~Format#format</a>
  53. </li></ul></dd>
  54. <dt class="tag-source">Source:</dt>
  55. <dd class="tag-source"><ul class="dummy"><li>
  56. <a href="polyfill_Intl_Format.js.html">polyfill/Intl/Format.js</a>, <a href="polyfill_Intl_Format.js.html#line75">line 75</a>
  57. </li></ul></dd>
  58. </dl>
  59. <h3 class="subsection-title">Methods</h3>
  60. <h4 class="name" id="resolvedOptions"><span class="type-signature"></span>resolvedOptions<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
  61. <div class="description">
  62. <p>Get the resolvedOptions</p>
  63. </div>
  64. <dl class="details">
  65. <dt class="inherited-from">Inherited From:</dt>
  66. <dd class="inherited-from"><ul class="dummy"><li>
  67. <a href="module-barejs_polyfill_Intl-Format.html#resolvedOptions">module:barejs/polyfill/Intl~Format#resolvedOptions</a>
  68. </li></ul></dd>
  69. <dt class="tag-source">Source:</dt>
  70. <dd class="tag-source"><ul class="dummy"><li>
  71. <a href="polyfill_Intl_Format.js.html">polyfill/Intl/Format.js</a>, <a href="polyfill_Intl_Format.js.html#line61">line 61</a>
  72. </li></ul></dd>
  73. </dl>
  74. <h5>Returns:</h5>
  75. <div class="param-desc">
  76. <p>The options</p>
  77. </div>
  78. <dl>
  79. <dt>
  80. Type
  81. </dt>
  82. <dd>
  83. <span class="param-type">Object</span>
  84. </dd>
  85. </dl>
  86. <h4 class="name" id="~formatDateTime"><span class="type-signature">(inner) </span>formatDateTime<span class="signature">(_date, _formatString, _utc)</span><span class="type-signature"> &rarr; {String}</span></h4>
  87. <div class="description">
  88. <p>Supports NUMERICAL formatting of dates, according to the formatting patterns described on
  89. http://<a href="http://www.unicode.org/reports/tr35/tr35-4.html#Date_Format_Patterns">www.unicode.org/reports/tr35/tr35-4.html#Date_Format_Patterns</a>
  90. Warning: does NOT support formats like MMMM which should be localized. This method should only
  91. be used to produce a fixed date format. It also doesn't support identifiers that require
  92. knowledge of a specific calendar system, like &quot;day of the week&quot; or &quot;era&quot;.</p>
  93. </div>
  94. <h5>Parameters:</h5>
  95. <table class="params">
  96. <thead>
  97. <tr>
  98. <th>Name</th>
  99. <th>Type</th>
  100. <th class="last">Description</th>
  101. </tr>
  102. </thead>
  103. <tbody>
  104. <tr>
  105. <td class="name"><code>_date</code></td>
  106. <td class="type">
  107. <span class="param-type">Date</span>
  108. </td>
  109. <td class="description last"><p>The date to format</p></td>
  110. </tr>
  111. <tr>
  112. <td class="name"><code>_formatString</code></td>
  113. <td class="type">
  114. <span class="param-type">String</span>
  115. </td>
  116. <td class="description last"><p>The formatString to use.</p></td>
  117. </tr>
  118. <tr>
  119. <td class="name"><code>_utc</code></td>
  120. <td class="type">
  121. <span class="param-type">Boolean</span>
  122. </td>
  123. <td class="description last"><p>Optional: set to true to use the UTC time zone instead of local.</p></td>
  124. </tr>
  125. </tbody>
  126. </table>
  127. <dl class="details">
  128. <dt class="tag-source">Source:</dt>
  129. <dd class="tag-source"><ul class="dummy"><li>
  130. <a href="polyfill_Intl_DateTimeFormat.js.html">polyfill/Intl/DateTimeFormat.js</a>, <a href="polyfill_Intl_DateTimeFormat.js.html#line101">line 101</a>
  131. </li></ul></dd>
  132. </dl>
  133. <h5>Returns:</h5>
  134. <div class="param-desc">
  135. <p>_date formatted as String using _pattern.</p>
  136. </div>
  137. <dl>
  138. <dt>
  139. Type
  140. </dt>
  141. <dd>
  142. <span class="param-type">String</span>
  143. </dd>
  144. </dl>
  145. </article>
  146. </section>
  147. </div>
  148. <nav>
  149. <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>
  150. </nav>
  151. <br class="clear">
  152. <footer>
  153. 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)
  154. </footer>
  155. <script> prettyPrint(); </script>
  156. <script src="scripts/linenumber.js"> </script>
  157. </body>
  158. </html>