luxon
Version:
Immutable date wrapper
995 lines (724 loc) • 300 kB
HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../">
<title data-ice="title">Luxon</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
<link data-ice="userStyle" rel="stylesheet" href="user/css/0-styles.css">
</head>
<body class="layout-container" data-ice="rootContainer">
<header><span class="luxon-title">Luxon</span>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a data-ice="repoURL" href="https://github.com/icambron/luxon" class="repo-url-github">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/duration.js~Duration.html">Duration</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/info.js~Info.html">Info</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/interval.js~Interval.html">Interval</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/settings.js~Settings.html">Settings</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-interface">I</span><span data-ice="name"><span><a href="class/src/zone.js~Zone.html">Zone</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div class="header-notice">
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {DateTime} from '<span><a href="file/src/datetime.js.html#lineNumber248">luxon/src/datetime.js</a></span>'</code></pre></div>
<span data-ice="access">public</span>
<span data-ice="kind">class</span>
<span data-ice="source">| <span><a href="file/src/datetime.js.html#lineNumber248">source</a></span></span>
</div>
<div class="self-detail detail">
<h1 data-ice="name">DateTime</h1>
<div class="description" data-ice="description"><p>A DateTime is an immutable data structure representing a specific date and time and accompanying methods. It contains class and instance methods for creating, parsing, interrogating, transforming, and formatting them.</p>
<p>A DateTime comprises of:</p>
<ul>
<li>A timestamp. Each DateTime instance refers to a specific millisecond of the Unix epoch.</li>
<li>A time zone. Each instance is considered in the context of a specific zone (by default the local system's zone).</li>
<li>Configuration properties that effect how output strings are formatted, such as <code>locale</code>, <code>numberingSystem</code>, and <code>outputCalendar</code>.</li>
</ul>
<p>Here is a brief overview of the most commonly used functionality it provides:</p>
<ul>
<li><strong>Creation</strong>: To create a DateTime from its components, use one of its factory class methods: <span><a href="class/src/datetime.js~DateTime.html#static-method-local">local</a></span>, <span><a href="class/src/datetime.js~DateTime.html#static-method-utc">utc</a></span>, and (most flexibly) <span><a href="class/src/datetime.js~DateTime.html#static-method-fromObject">fromObject</a></span>. To create one from a standard string format, use <span><a href="class/src/datetime.js~DateTime.html#static-method-fromISO">fromISO</a></span>, <span><a href="class/src/datetime.js~DateTime.html#static-method-fromHTTP">fromHTTP</a></span>, and <span><a href="class/src/datetime.js~DateTime.html#static-method-fromRFC2822">fromRFC2822</a></span>. To create one from a custom string format, use <span><a href="class/src/datetime.js~DateTime.html#static-method-fromString">fromString</a></span>. To create one from a native JS date, use <span><a href="class/src/datetime.js~DateTime.html#static-method-fromJSDate">fromJSDate</a></span>.</li>
<li><strong>Gregorian calendar and time</strong>: To examine the Gregorian properties of a DateTime individually (i.e as opposed to collectively through <span><a href="class/src/datetime.js~DateTime.html#instance-method-toObject">toObject</a></span>), use the <span><a href="class/src/datetime.js~DateTime.html#instance-get-year">year</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-month">month</a></span>,
<span><a href="class/src/datetime.js~DateTime.html#instance-get-day">day</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-hour">hour</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-minute">minute</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-second">second</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-millisecond">millisecond</a></span> accessors.</li>
<li><strong>Week calendar</strong>: For ISO week calendar attributes, see the <span><a href="class/src/datetime.js~DateTime.html#instance-get-weekYear">weekYear</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-get-weekNumber">weekNumber</a></span>, and <span><a href="class/src/datetime.js~DateTime.html#instance-get-weekday">weekday</a></span> accessors.</li>
<li><strong>Configuration</strong> See the <span><a href="class/src/datetime.js~DateTime.html#instance-get-locale">locale</a></span> and <span><a href="class/src/datetime.js~DateTime.html#instance-get-numberingSystem">numberingSystem</a></span> accessors.</li>
<li><strong>Transformation</strong>: To transform the DateTime into other DateTimes, use <span><a href="class/src/datetime.js~DateTime.html#instance-method-set">set</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-reconfigure">reconfigure</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-setZone">setZone</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-setLocale">setLocale</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-plus">plus</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-minus">minus</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-endOf">endOf</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-startOf">startOf</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toUTC">toUTC</a></span>, and <span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocal">toLocal</a></span>.</li>
<li><strong>Output</strong>: To convert the DateTime to other representations, use the <span><a href="class/src/datetime.js~DateTime.html#instance-method-toJSON">toJSON</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toISO">toISO</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toHTTP">toHTTP</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toObject">toObject</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toRFC2822">toRFC2822</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toString">toString</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span>, <span><a href="class/src/datetime.js~DateTime.html#instance-method-toFormat">toFormat</a></span>, and <span><a href="class/src/datetime.js~DateTime.html#instance-method-valueOf">valueOf</a></span>.</li>
</ul>
<p>There's plenty others documented below. In addition, for more information on subtler topics like internationalization, time zones, alternative calendars, validity, and so on, see the external documentation.</p>
</div>
</div>
<div data-ice="staticMemberSummary"><h2>Static Member Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Members</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_FULL">DATETIME_FULL</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'October 14, 1983, 9:30 AM EDT'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_FULL_WITH_SECONDS">DATETIME_FULL_WITH_SECONDS</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'October 14, 1983, 9:303 AM EDT'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_HUGE">DATETIME_HUGE</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "weekday": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Friday, October 14, 1983, 9:30 AM Eastern Daylight Time'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_HUGE_WITH_SECONDS">DATETIME_HUGE_WITH_SECONDS</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "weekday": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Friday, October 14, 1983, 9:30:33 AM Eastern Daylight Time'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_MED">DATETIME_MED</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Oct 14, 1983, 9:30 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_MED_WITH_SECONDS">DATETIME_MED_WITH_SECONDS</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Oct 14, 1983, 9:30:33 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_SHORT">DATETIME_SHORT</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '10/14/1983, 9:30 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATETIME_SHORT_WITH_SECONDS">DATETIME_SHORT_WITH_SECONDS</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '10/14/1983, 9:30:33 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATE_FULL">DATE_FULL</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'October 14, 1983'</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATE_HUGE">DATE_HUGE</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "weekday": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Tuesday, October 14, 1983'</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATE_MED">DATE_MED</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 'Oct 14, 1983'</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-DATE_SHORT">DATE_SHORT</a></span></span><span data-ice="signature">: {"year": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "month": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "day": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like 10/14/1983</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_24_SIMPLE">TIME_24_SIMPLE</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour12": <span>*</span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30', always 24-hour.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_24_WITH_LONG_OFFSET">TIME_24_WITH_LONG_OFFSET</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour12": <span>*</span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23 Eastern Daylight Time', always 24-hour.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_24_WITH_SECONDS">TIME_24_WITH_SECONDS</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour12": <span>*</span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23', always 24-hour.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_24_WITH_SHORT_OFFSET">TIME_24_WITH_SHORT_OFFSET</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "hour12": <span>*</span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23 EDT', always 24-hour.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_SIMPLE">TIME_SIMPLE</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_WITH_LONG_OFFSET">TIME_WITH_LONG_OFFSET</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23 AM Eastern Daylight Time'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_WITH_SECONDS">TIME_WITH_SECONDS</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23 AM'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-get-TIME_WITH_SHORT_OFFSET">TIME_WITH_SHORT_OFFSET</a></span></span><span data-ice="signature">: {"hour": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "minute": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "second": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, "timeZoneName": <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>}</span>
</p>
</div>
<div>
<div data-ice="description"><p><span><a href="class/src/datetime.js~DateTime.html#instance-method-toLocaleString">toLocaleString</a></span> format like '09:30:23 AM EDT'.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="staticMethodSummary"><h2>Static Method Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Methods</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromHTTP">fromHTTP</a></span></span><span data-ice="signature">(text: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create a DateTime from an HTTP header date</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromISO">fromISO</a></span></span><span data-ice="signature">(text: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, opts: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create a DateTime from an ISO 8601 string</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromJSDate">fromJSDate</a></span></span><span data-ice="signature">(date: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a></span> | <span>Any</span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create an DateTime from a Javascript Date object.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromMillis">fromMillis</a></span></span><span data-ice="signature">(milliseconds: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create an DateTime from a count of epoch milliseconds.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromObject">fromObject</a></span></span><span data-ice="signature">(obj: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create an DateTime from a Javascript object with keys like 'year' and 'hour' with reasonable defaults.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromRFC2822">fromRFC2822</a></span></span><span data-ice="signature">(text: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, opts: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create a DateTime from an RFC 2822 string</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromString">fromString</a></span></span><span data-ice="signature">(text: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, fmt: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create a DateTime from an input string and format string</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-fromStringExplain">fromStringExplain</a></span></span><span data-ice="signature">(text: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, fmt: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>, options: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Explain how a string would be parsed by fromString()</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-invalid">invalid</a></span></span><span data-ice="signature">(reason: <span>*</span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create an invalid DateTime.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-local">local</a></span></span><span data-ice="signature">(year: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, month: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, day: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, hour: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, minute: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, second: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>, millisecond: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Create a local DateTime</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/datetime.js~DateTime.html#static-method-max">max</a></span></span><span data-ice="signature">(dateTimes: ...<span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span>): <span><a href="class/src/datetime.js~DateTime.html">DateTime</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Return the max of several date times</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="na