luxon
Version:
Immutable date wrapper
626 lines (321 loc) • 15.3 kB
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 {Settings} from '<span><a href="file/src/settings.js.html#lineNumber11">luxon/src/settings.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/settings.js.html#lineNumber11">source</a></span></span>
</div>
<div class="self-detail detail">
<h1 data-ice="name">Settings</h1>
<div class="description" data-ice="description"><p>Settings contains static getters and setters that control Luxon's overall behavior. Luxon is a simple library with few options, but the ones it does have live here.</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/settings.js~Settings.html#static-get-defaultZone">defaultZone</a></span></span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Get the default time zone object to create DateTimes in.</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/settings.js~Settings.html#static-get-defaultZoneName">defaultZoneName</a></span></span><span data-ice="signature">: <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>Set the default time zone to create DateTimes in.</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">set</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/settings.js~Settings.html#static-set-defaultZoneName">defaultZoneName</a></span></span><span data-ice="signature">: <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>Set the default time zone to create DateTimes in.</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/settings.js~Settings.html#static-get-now">now</a></span></span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Get the callback for returning the current timestamp.</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">set</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/settings.js~Settings.html#static-set-now">now</a></span></span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Set the callback for returning the current timestamp.</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/settings.js~Settings.html#static-get-throwOnInvalid">throwOnInvalid</a></span></span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Get whether Luxon will throw when it encounters invalid DateTimes, Durations, or Intervals</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">set</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/src/settings.js~Settings.html#static-set-throwOnInvalid">throwOnInvalid</a></span></span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Set whether Luxon will throw when it encounters invalid DateTimes, Durations, or Intervals</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="staticMemberDetails"><h2 data-ice="title">Static Public Members</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-get-defaultZone">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span data-ice="name">defaultZone</span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber48">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Get the default time zone object to create DateTimes in.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-get-defaultZoneName">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span data-ice="name">defaultZoneName</span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber32">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Set the default time zone to create DateTimes in.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-set-defaultZoneName">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">set</span>
<span data-ice="name">defaultZoneName</span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber40">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Set the default time zone to create DateTimes in.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-get-now">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span data-ice="name">now</span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber16">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Get the callback for returning the current timestamp.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-set-now">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">set</span>
<span data-ice="name">now</span><span data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">function</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber24">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Set the callback for returning the current timestamp.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-get-throwOnInvalid">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">get</span>
<span data-ice="name">throwOnInvalid</span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber56">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Get whether Luxon will throw when it encounters invalid DateTimes, Durations, or Intervals</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-set-throwOnInvalid">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="kind" data-ice="kind">set</span>
<span data-ice="name">throwOnInvalid</span><span data-ice="signature">: <span><a href="class/src/zone.js~Zone.html">Zone</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/settings.js.html#lineNumber64">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Set whether Luxon will throw when it encounters invalid DateTimes, Durations, or Intervals</p>
</div>
<div data-ice="properties">
</div>
</div>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>