chek
Version:
Minimal utility for checking types, working with arrays and objects.
346 lines • 19.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IDateFormat | Chek</title>
<meta name="description" content="Documentation for Chek">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Chek</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Chek</a>
</li>
<li>
<a href="idateformat.html">IDateFormat</a>
</li>
</ul>
<h1>Interface IDateFormat</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">DateTimeFormatOptions</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">IDateFormat</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#day" class="tsd-kind-icon">day</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#era" class="tsd-kind-icon">era</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#formatmatcher" class="tsd-kind-icon">format<wbr>Matcher</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#hour" class="tsd-kind-icon">hour</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#hour12" class="tsd-kind-icon">hour12</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#localematcher" class="tsd-kind-icon">locale<wbr>Matcher</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="idateformat.html#locales" class="tsd-kind-icon">locales</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#minute" class="tsd-kind-icon">minute</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#month" class="tsd-kind-icon">month</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#second" class="tsd-kind-icon">second</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#timezone" class="tsd-kind-icon">time<wbr>Zone</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#timezonename" class="tsd-kind-icon">time<wbr>Zone<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#weekday" class="tsd-kind-icon">weekday</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="idateformat.html#year" class="tsd-kind-icon">year</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="day" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> day</h3>
<div class="tsd-signature tsd-kind-icon">day<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.day</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4358</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="era" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> era</h3>
<div class="tsd-signature tsd-kind-icon">era<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"long"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"short"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"narrow"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.era</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4355</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="formatmatcher" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> format<wbr>Matcher</h3>
<div class="tsd-signature tsd-kind-icon">format<wbr>Matcher<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"best fit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"basic"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.formatMatcher</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4363</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="hour" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hour</h3>
<div class="tsd-signature tsd-kind-icon">hour<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.hour</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4359</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="hour12" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hour12</h3>
<div class="tsd-signature tsd-kind-icon">hour12<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.hour12</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4364</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="localematcher" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> locale<wbr>Matcher</h3>
<div class="tsd-signature tsd-kind-icon">locale<wbr>Matcher<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"best fit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"lookup"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.localeMatcher</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4353</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="locales" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> locales</h3>
<div class="tsd-signature tsd-kind-icon">locales<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/origin1tech/chek/blob/7537f4d/src/types.ts#L18">src/types.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="minute" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> minute</h3>
<div class="tsd-signature tsd-kind-icon">minute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.minute</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4360</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="month" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> month</h3>
<div class="tsd-signature tsd-kind-icon">month<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"long"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"short"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"narrow"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.month</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4357</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="second" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> second</h3>
<div class="tsd-signature tsd-kind-icon">second<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.second</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4361</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="timezone" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> time<wbr>Zone</h3>
<div class="tsd-signature tsd-kind-icon">time<wbr>Zone<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.timeZone</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4365</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="timezonename" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> time<wbr>Zone<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">time<wbr>Zone<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"long"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"short"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.timeZoneName</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4362</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="weekday" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> weekday</h3>
<div class="tsd-signature tsd-kind-icon">weekday<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"long"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"short"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"narrow"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.weekday</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4354</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="year" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> year</h3>
<div class="tsd-signature tsd-kind-icon">year<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"numeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2-digit"</span></div>
<aside class="tsd-sources">
<p>Inherited from Intl.DateTimeFormatOptions.year</p>
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:4356</li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="idateformat.html" class="tsd-kind-icon">IDate<wbr>Format</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#day" class="tsd-kind-icon">day</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#era" class="tsd-kind-icon">era</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#formatmatcher" class="tsd-kind-icon">format<wbr>Matcher</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#hour" class="tsd-kind-icon">hour</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#hour12" class="tsd-kind-icon">hour12</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#localematcher" class="tsd-kind-icon">locale<wbr>Matcher</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="idateformat.html#locales" class="tsd-kind-icon">locales</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#minute" class="tsd-kind-icon">minute</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#month" class="tsd-kind-icon">month</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#second" class="tsd-kind-icon">second</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#timezone" class="tsd-kind-icon">time<wbr>Zone</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#timezonename" class="tsd-kind-icon">time<wbr>Zone<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#weekday" class="tsd-kind-icon">weekday</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="idateformat.html#year" class="tsd-kind-icon">year</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>