diff-ymd-package
Version:
A javascript library for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.
1,504 lines (373 loc) • 16.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>diff-ymd-package Documentation</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"><a href="https://github.com/farhan7reza7/diff-ymd-package">diff-ymd-package</a> Source</h1>
<section>
<header>
<h4>diff-ymd-package provides APIs for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.</h4>
</header>
</section>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>DatesYMD<span class="signature">(firstDate, secondDate)</span><span class="type-signature"></span></h2>
<div class="class-description">Represents a javascript class for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or nDays or mWeeks etc.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="DatesYMD"><span class="type-signature"></span>new DatesYMD<span class="signature">(firstDate, secondDate)</span><span class="type-signature"></span></h4>
<div class="description">
Creates an instance of DatesYMD.
</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>firstDate</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(type- String but Number for epoch, and Object for dateObject) - The first date in the format 'yyyy-mm-dd' or 'yyyy/mm/dd' or yyyy.mm.dd or dateString or dateObject
or Timestamp(epoch).</td>
</tr>
<tr>
<td class="name"><code>secondDate</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(type- String but Number for epoch, and Object for dateObject) - The second date in the format 'yyyy-mm-dd' or 'yyyy/mm/dd' or yyyy.mm.dd or dateString or dateObject
or Timestamp(epoch).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="customizeFormat"><span class="type-signature"></span>customizeFormat<span class="signature">(yearUnit, monthUnit, dayUnit, partSeparator)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Customizes the difference using specified units and separators like (a + yearUnit + partSeparator + b + monthUnit + partSeparator + c + dayUnit), eg. aYs-bMs-cDs etc.
</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>yearUnit</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unit for years.</td>
</tr>
<tr>
<td class="name"><code>monthUnit</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unit for months.</td>
</tr>
<tr>
<td class="name"><code>dayUnit</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unit for days.</td>
</tr>
<tr>
<td class="name"><code>partSeparator</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The separator between year, month, and day parts.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line189">line 189</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The customized formatted difference.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="diffArray"><span class="type-signature"></span>diffArray<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
<div class="description">
Calculates the difference between two dates and returns an array containing Y, M, D, and a formatted 'aY bM cD' difference string.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line73">line 73</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
An array containing the calculated years, months, days, and the formatted difference.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="diffInDays"><span class="type-signature"></span>diffInDays<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in days between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line254">line 254</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in days.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInHours"><span class="type-signature"></span>diffInHours<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in hours between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line293">line 293</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in hours.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInMinutes"><span class="type-signature"></span>diffInMinutes<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in minutes between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line311">line 311</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in minutes.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInMonths"><span class="type-signature"></span>diffInMonths<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in months between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line212">line 212</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in months.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInSeconds"><span class="type-signature"></span>diffInSeconds<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in seconds between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line329">line 329</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in seconds.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInWeeks"><span class="type-signature"></span>diffInWeeks<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in weeks between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line233">line 233</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in weeks.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="diffInYears"><span class="type-signature"></span>diffInYears<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Calculates the difference in years between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line275">line 275</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The difference in years.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="formattedYMD"><span class="type-signature"></span>formattedYMD<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Returns the formatted difference between two dates.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="diff-ymd.js.html">diff-ymd.js</a>, <a href="diff-ymd.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The formatted difference in the format 'aY bM cD'.
</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>Classes</h3>
<ul>
<li><a href="global.html#DatesYMD">DatesYMD</a></li>
</ul>
<h3>Global</h3>
<ul>
<li><a href="global.html#DatesYMD">DatesYMD</a></li>
</ul>
<h3>Global object special method</h3>
<ul>
<li><a href="global.html#diffDates">diffDates</a></li>
</ul>
<h3>diff as Global Date Object method</h3>
<ul>
<li><a href="global.html#diff">diff</a></li>
</ul>
<h3>DatesYMD Methods</h3>
<ul>
<li><a href="global.html#customizeFormat">customizeFormat</a></li>
<li><a href="global.html#diffArray">diffArray</a></li>
<li><a href="global.html#diffInDays">diffInDays</a></li>
<li><a href="global.html#diffInHours">diffInHours</a></li>
<li><a href="global.html#diffInMinutes">diffInMinutes</a></li>
<li><a href="global.html#diffInMonths">diffInMonths</a></li>
<li><a href="global.html#diffInSeconds">diffInSeconds</a></li>
<li><a href="global.html#diffInWeeks">diffInWeeks</a></li>
<li><a href="global.html#diffInYears">diffInYears</a></li>
<li><a href="global.html#formattedYMD">formattedYMD</a></li>
</ul>
</nav>
<br class="clear">
<footer>
Documentation generated for
<a href="https://www.npmjs.com/package/diff-ymd-package">diff-ymd-package</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>