123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Class: DateTimeFormat</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Class: DateTimeFormat</h1>
-
- <section>
- <header>
-
- <h2><span class="attribs"><span class="type-signature"></span></span>
- <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>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
-
- <h4 class="name" id="DateTimeFormat"><span class="type-signature"></span>new DateTimeFormat<span class="signature">()</span><span class="type-signature"></span></h4>
-
-
- <div class="description">
- <p>Provides Date/Time formatting</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="polyfill_Intl_DateTimeFormat.js.html">polyfill/Intl/DateTimeFormat.js</a>, <a href="polyfill_Intl_DateTimeFormat.js.html#line267">line 267</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
- </div>
-
- <h3 class="subsection-title">Extends</h3>
-
- <ul>
- <li><a href="module-barejs_polyfill_Intl-Format.html">module:barejs/polyfill/Intl~Format</a></li>
- </ul>
-
-
-
- <h3 class="subsection-title">Classes</h3>
- <dl>
- <dt><a href="module-barejs_polyfill_Intl.DateTimeFormat-DateTimeFormatOptions.html">DateTimeFormatOptions</a></dt>
- <dd></dd>
- </dl>
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <h4 class="name" id="format"><span class="type-signature"></span>format<span class="type-signature"></span></h4>
- <div class="description">
- <p>Format a value</p>
- </div>
- <dl class="details">
-
-
-
-
- <dt class="tag-overrides">Overrides:</dt>
- <dd class="tag-overrides"><ul class="dummy"><li>
- <a href="module-barejs_polyfill_Intl-Format.html#format">module:barejs/polyfill/Intl~Format#format</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="polyfill_Intl_Format.js.html">polyfill/Intl/Format.js</a>, <a href="polyfill_Intl_Format.js.html#line75">line 75</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
-
- <h4 class="name" id="resolvedOptions"><span class="type-signature"></span>resolvedOptions<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
-
-
- <div class="description">
- <p>Get the resolvedOptions</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="module-barejs_polyfill_Intl-Format.html#resolvedOptions">module:barejs/polyfill/Intl~Format#resolvedOptions</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="polyfill_Intl_Format.js.html">polyfill/Intl/Format.js</a>, <a href="polyfill_Intl_Format.js.html#line61">line 61</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>The options</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object</span>
- </dd>
- </dl>
-
-
-
-
-
- <h4 class="name" id="~formatDateTime"><span class="type-signature">(inner) </span>formatDateTime<span class="signature">(_date, _formatString, _utc)</span><span class="type-signature"> → {String}</span></h4>
-
-
- <div class="description">
- <p>Supports NUMERICAL formatting of dates, according to the formatting patterns described on
- 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>
- Warning: does NOT support formats like MMMM which should be localized. This method should only
- be used to produce a fixed date format. It also doesn't support identifiers that require
- knowledge of a specific calendar system, like "day of the week" or "era".</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>_date</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Date</span>
-
- </td>
-
-
- <td class="description last"><p>The date to format</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>_formatString</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>The formatString to use.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>_utc</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Boolean</span>
-
- </td>
-
-
- <td class="description last"><p>Optional: set to true to use the UTC time zone instead of local.</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="polyfill_Intl_DateTimeFormat.js.html">polyfill/Intl/DateTimeFormat.js</a>, <a href="polyfill_Intl_DateTimeFormat.js.html#line101">line 101</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>_date formatted as String using _pattern.</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">String</span>
- </dd>
- </dl>
-
-
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <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>
- </nav>
- <br class="clear">
- <footer>
- 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)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|