json-timeline
Version:
Generate Interactive Timelines stored in JSON Advents with Tags.
259 lines (77 loc) • 3.64 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: compareDates</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">Module: compareDates</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~compareDates"><span class="type-signature">(inner) </span>compareDates<span class="signature">(date1, date2)</span><span class="type-signature"></span></h4>
<div class="description">
Comparison Function for Dates
</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>date1</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Date 1</td>
</tr>
<tr>
<td class="name"><code>date2</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Date 2</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="util_compareDates.js.html">util/compareDates.js</a>, <a href="util_compareDates.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
-1 if date1 < date2, 0 if date1 == date2, 1 if date1 > date2
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-advents.html">advents</a></li><li><a href="module-compareDates.html">compareDates</a></li><li><a href="module-groupAdvents.html">groupAdvents</a></li><li><a href="module-index.html">index</a></li><li><a href="module-isType.html">isType</a></li><li><a href="module-json-timeline.html">json-timeline</a></li><li><a href="module-loadAdvents.html">loadAdvents</a></li><li><a href="module-renderAdvents.html">renderAdvents</a></li><li><a href="module-schemas.html">schemas</a></li><li><a href="module-sortAdvents.html">sortAdvents</a></li><li><a href="module-validateSchema.html">validateSchema</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Dec 14 2020 23:14:56 GMT-0500 (Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>