<!DOCTYPE html>
|
|
<html lang="en">
|
<head>
|
<meta charset="utf-8">
|
<title>Date-Utils Class: Date</title>
|
|
<!--[if lt IE 9]>
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
<![endif]-->
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/site.journal.css">
|
|
</head>
|
|
<body>
|
<div class="container-fluid">
|
<div class="navbar navbar-fixed-top navbar-inverse">
|
<div class="navbar-inner">
|
<a class="brand" href="index.html">Date-Utils</a>
|
<ul class="nav">
|
|
<li class="dropdown">
|
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
|
class="caret"></b></a>
|
|
<ul class="dropdown-menu ">
|
|
<li>
|
<a href="Date.html">Date</a>
|
</li>
|
|
|
</ul>
|
</li>
|
|
</ul>
|
</div>
|
</div>
|
|
<div class="row-fluid">
|
|
|
<div class="span8">
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Class: Date</h1>
|
<section>
|
|
<header>
|
<h2>
|
Date
|
</h2>
|
|
</header>
|
|
<article>
|
<div class="container-overview">
|
|
|
|
|
<dt>
|
<h4 class="name" id="Date"><span class="type-signature"></span>new Date<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="subsection-title">Methods</h3>
|
|
<dl>
|
|
<dt>
|
<h4 class="name" id="compare"><span class="type-signature"><static> </span>compare<span class="signature">(date1, date2)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares two dates</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<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"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>first date</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>date2</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>second date</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>-1 if date1 is less than date2, 0 if they are equal, 1 if date1 is more than date2</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="equals"><span class="type-signature"><static> </span>equals<span class="signature">(date1, date2)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares two dates to the millisecond</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<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"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>first date</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>date2</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>second date</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="equalsDay"><span class="type-signature"><static> </span>equalsDay<span class="signature">(date1, date2)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares two dates by day</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<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"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>first date</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>date2</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>second date</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getDayNumberFromName"><span class="type-signature"><static> </span>getDayNumberFromName<span class="signature">(day)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the day number for a day [0-6]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>day</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">String</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>day name</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getDaysInMonth"><span class="type-signature"><static> </span>getDaysInMonth<span class="signature">(year, month)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of days in a month</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>year</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>year</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthAbbrFromNumber"><span class="type-signature"><static> </span>getMonthAbbrFromNumber<span class="signature">(month)</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the month name abbreviated for a month [0-11]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthNameFromNumber"><span class="type-signature"><static> </span>getMonthNameFromNumber<span class="signature">(month)</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the month name for a month [0-11]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthNumberFromName"><span class="type-signature"><static> </span>getMonthNumberFromName<span class="signature">(month)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the day number for a month [0-11]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">String</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month name</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="isLeapYear"><span class="type-signature"><static> </span>isLeapYear<span class="signature">(year)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether or not the year is a leap year</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>year</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>year</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="today"><span class="type-signature"><static> </span>today<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to today and
|
the time set to midnight</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Today's Date</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="tomorrow"><span class="type-signature"><static> </span>tomorrow<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to tomorrow and
|
the time set to midnight</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Tomorrow's Date</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="UTCtoday"><span class="type-signature"><static> </span>UTCtoday<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to today and
|
the time set to midnight in UTC</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Today's Date in UTC</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="UTCtomorrow"><span class="type-signature"><static> </span>UTCtomorrow<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to tomorrow and
|
the time set to midnight in UTC</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Tomorrow's Date in UTC</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="UTCyesterday"><span class="type-signature"><static> </span>UTCyesterday<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to yesterday and
|
the time set to midnight in UTC</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Yesterday's Date in UTC</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateDay"><span class="type-signature"><static> </span>validateDay<span class="signature">(day, year, month)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the day is valid</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>day</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>day of the month</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>year</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>year</p></td>
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month of the year [0-11]</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateHour"><span class="type-signature"><static> </span>validateHour<span class="signature">(hour)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the hour is valid [0-23]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>hour</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>hour</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateMillisecond"><span class="type-signature"><static> </span>validateMillisecond<span class="signature">(millisecond)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the millisecond is valid</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>millisecond</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>millisecond</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateMinute"><span class="type-signature"><static> </span>validateMinute<span class="signature">(minute)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the minute is valid</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>minute</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>minute</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateMonth"><span class="type-signature"><static> </span>validateMonth<span class="signature">(month)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the month is valid [0-11]</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>month</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>month</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateSecond"><span class="type-signature"><static> </span>validateSecond<span class="signature">(second)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the second is valid</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>second</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>second</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="validateYear"><span class="type-signature"><static> </span>validateYear<span class="signature">(year)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether the year is valid</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>year</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>year</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="yesterday"><span class="type-signature"><static> </span>yesterday<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns new instance of Date object with the date set to yesterday and
|
the time set to midnight</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>Yesterday's Date</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(additions)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds <code>milliseconds</code>, <code>seconds</code>, <code>minutes</code>, <code>hours</code>, <code>days</code>, <code>weeks</code>, <code>months</code>, and <code>years</code> and returns a new Date.
|
Usage: <code>data.add({ "seconds": 10, "days": 1 })</code></p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>additions</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Object</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addHours"><span class="type-signature"></span>addHours<span class="signature">(hours)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds hours to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>hours</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of hours to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addMilliseconds"><span class="type-signature"></span>addMilliseconds<span class="signature">(milliseconds)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds milliseconds to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>milliseconds</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of milliseconds to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addMinutes"><span class="type-signature"></span>addMinutes<span class="signature">(minutes)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds minutes to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>minutes</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of minutes to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addMonths"><span class="type-signature"></span>addMonths<span class="signature">(months)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds months to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>months</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of months to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addSeconds"><span class="type-signature"></span>addSeconds<span class="signature">(seconds)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds seconds to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>seconds</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of seconds to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addSeconds"><span class="type-signature"></span>addSeconds<span class="signature">(days)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds days to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>days</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of days to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addWeekdays"><span class="type-signature"></span>addWeekdays<span class="signature">(weekdays)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds weekdays based on a Mon-Fri work schedule and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>weekdays</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of weekdays to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addWeeks"><span class="type-signature"></span>addWeeks<span class="signature">(weeks)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds weeks to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>weeks</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of weeks to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="addYears"><span class="type-signature"></span>addYears<span class="signature">(years)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Adds years to the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>years</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of years to add</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of add</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="between"><span class="type-signature"></span>between<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns whether this Date is between a start and end date</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="clearTime"><span class="type-signature"></span>clearTime<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Sets the time to 00:00:00.0000 and returns a new Date object</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="clearUTCTime"><span class="type-signature"></span>clearUTCTime<span class="signature">()</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Sets the time to 00:00:00.0000 and returns a new Date object with set to UTC</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns a cloned copy of the current Date</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="compareTo"><span class="type-signature"></span>compareTo<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares a Date to this Date</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
<div class="param-desc">
|
<p>-1 if less than date, 0 if they are equal, 1 if more than date</p>
|
</div>
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(Date)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares a Date and time to this Date and time for equality</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="equalsDay"><span class="type-signature"></span>equalsDay<span class="signature">(Date)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares a Date to this Date for equality</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getDaysBetween"><span class="type-signature"></span>getDaysBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of days between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getFullWeekNumber"><span class="type-signature"></span>getFullWeekNumber<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the week number of this Date, zero padded</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getHoursBetween"><span class="type-signature"></span>getHoursBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of hours between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getLastMonthName"><span class="type-signature"></span>getLastMonthName<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the name of last month</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMillisecondsBetween"><span class="type-signature"></span>getMillisecondsBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of milliseconds between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMinutesBetween"><span class="type-signature"></span>getMinutesBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of minutes between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthAbbr"><span class="type-signature"></span>getMonthAbbr<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the abbreviated month name</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthName"><span class="type-signature"></span>getMonthName<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the month name</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getMonthsBetween"><span class="type-signature"></span>getMonthsBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of months between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getOrdinalNumber"><span class="type-signature"></span>getOrdinalNumber<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the ordinal number of this Date</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getSecondsBetween"><span class="type-signature"></span>getSecondsBetween<span class="signature">(Date)</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the number of seconds between this Date and the Date passed in</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getUTCOffset"><span class="type-signature"></span>getUTCOffset<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the current UTC office</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="getWeekNumber"><span class="type-signature"></span>getWeekNumber<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the week number of this Date</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Number</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="isAfter"><span class="type-signature"></span>isAfter<span class="signature">(Date)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares a Date to this Date for to see if it is after the Date passed</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="isBefore"><span class="type-signature"></span>isBefore<span class="signature">(Date)</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Compares a Date to this Date for to see if it is before the Date passed</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>Date</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>to compare to</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="isToday"><span class="type-signature"></span>isToday<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Checks to see if the Date is today</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="isWeekend"><span class="type-signature"></span>isWeekend<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns <code>true</code> if the Date is a weekend using standard Saturday/Sunday definition of a weekend</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">Boolean</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(removals)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes <code>milliseconds</code>, <code>seconds</code>, <code>minutes</code>, <code>hours</code>, <code>days</code>, <code>weeks</code>, <code>months</code>, and <code>years</code> and returns a new Date.
|
Usage: <code>data.remove({ "seconds": 10, "days": 1 })</code></p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>removals</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Object</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeDays"><span class="type-signature"></span>removeDays<span class="signature">(days)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes days from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>days</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of days to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeHours"><span class="type-signature"></span>removeHours<span class="signature">(hours)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes hours from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>hours</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of hours to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeMilliseconds"><span class="type-signature"></span>removeMilliseconds<span class="signature">(milliseconds)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes milliseconds from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>milliseconds</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of millseconds to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeMinutes"><span class="type-signature"></span>removeMinutes<span class="signature">(seconds)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes minutes from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>seconds</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of minutes to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeMonths"><span class="type-signature"></span>removeMonths<span class="signature">(months)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes months from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>months</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of months to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeSeconds"><span class="type-signature"></span>removeSeconds<span class="signature">(seconds)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes seconds from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>seconds</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of seconds to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeWeeks"><span class="type-signature"></span>removeWeeks<span class="signature">(weeks)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes weeks from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>weeks</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of weeks to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="removeYears"><span class="type-signature"></span>removeYears<span class="signature">(years)</span><span class="type-signature"> → {<a href="Date.html">Date</a>}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Removes years from the Date and returns it</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>years</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">Number</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Number of years to remove</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of remove</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type"><a href="Date.html">Date</a></span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="setTimeToNow"><span class="type-signature"></span>setTimeToNow<span class="signature">()</span><span class="type-signature"></span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Sets the time and date to now</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="toCLFString"><span class="type-signature"></span>toCLFString<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns a padded Common Log Format</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of toFormat</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="toDBString"><span class="type-signature"></span>toDBString<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns a formatted String for database insertion</p>
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of toFormat</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="toFormat"><span class="type-signature"></span>toFormat<span class="signature">(format)</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the a formatted version of this Date</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>format</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">String</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Format of the Date, using <code>YYYY</code>, <code>YY</code>, <code>MM</code>, <code>DD</code>, <code>HH</code>, <code>HH24</code>, <code>MI</code>, <code>SS</code>, etc</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="toUTCFormat"><span class="type-signature"></span>toUTCFormat<span class="signature">(format)</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns the a formatted version of the UTC version of this Date</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>format</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">String</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>Format of the Date, using <code>YYYY</code>, <code>YY</code>, <code>MM</code>, <code>DD</code>, <code>HH</code>, <code>HH24</code>, <code>MI</code>, <code>SS</code>, etc</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
|
|
<dt>
|
<h4 class="name" id="toYMD"><span class="type-signature"></span>toYMD<span class="signature">(separator)</span><span class="type-signature"> → {String}</span></h4>
|
|
|
</dt>
|
<dd>
|
|
|
<div class="description">
|
<p>Returns a padded Year/Month/Day</p>
|
</div>
|
|
|
|
|
|
|
|
<h5>Parameters:</h5>
|
|
|
<table class="params table table-striped">
|
<thead>
|
<tr>
|
|
<th>Name</th>
|
|
|
<th>Type</th>
|
|
|
|
|
|
<th class="last">Description</th>
|
</tr>
|
</thead>
|
|
<tbody>
|
|
|
<tr>
|
|
<td class="name"><code>separator</code></td>
|
|
|
<td class="type">
|
|
|
<span class="param-type">String</span>
|
|
|
|
</td>
|
|
|
|
|
|
<td class="description last"><p>optional, defaults to "-"</p></td>
|
</tr>
|
|
|
</tbody>
|
</table>
|
|
|
|
|
<dl class="details">
|
|
|
|
|
|
|
|
|
|
<dt class="important tag-deprecated">Deprecated:</dt>
|
|
<dd>
|
<ul class="dummy">
|
<li>Will be deprecated in version 2.0 in favor of toFormat</li>
|
</ul>
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h5>Returns:</h5>
|
|
|
|
|
<dl>
|
<dt>
|
Type
|
</dt>
|
<dd>
|
|
<span class="param-type">String</span>
|
|
|
</dd>
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
</div>
|
|
<div class="clearfix"></div>
|
<footer>
|
|
|
<span class="jsdoc-message">
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
|
on 2016-04-18T20:32:20-07:00 using the <a
|
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
</span>
|
</footer>
|
</div>
|
|
|
<div class="span3">
|
<div id="toc"></div>
|
</div>
|
|
<br clear="both">
|
</div>
|
|
</div>
|
<!--<script src="scripts/sunlight.js"></script>-->
|
<script src="scripts/docstrap.lib.js"></script>
|
<script src="scripts/bootstrap-dropdown.js"></script>
|
<script src="scripts/toc.js"></script>
|
|
<script>
|
$( function () {
|
$( "[id*='$']" ).each( function () {
|
var $this = $( this );
|
|
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
} );
|
|
$( "#toc" ).toc( {
|
anchorName : function ( i, heading, prefix ) {
|
return $( heading ).attr( "id" ) || ( prefix + i );
|
},
|
selectors : "h1,h2,h3,h4",
|
showAndHide : false,
|
scrollTo : "100px"
|
} );
|
|
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
$( '.dropdown-toggle' ).dropdown();
|
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
|
|
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
|
var $this = $( this );
|
|
var example = $this.find( "code" );
|
exampleText = example.html();
|
var lang = /{@lang (.*?)}/.exec( exampleText );
|
if ( lang && lang[1] ) {
|
exampleText = exampleText.replace( lang[0], "" );
|
example.html( exampleText );
|
lang = lang[1];
|
} else {
|
lang = "javascript";
|
}
|
|
if ( lang ) {
|
|
$this
|
.addClass( "sunlight-highlight-" + lang )
|
.addClass( "linenums" )
|
.html( example.html() );
|
|
}
|
} );
|
|
Sunlight.highlightAll( {
|
lineNumbers : true,
|
showMenu : true,
|
enableDoclinks : true
|
} );
|
} );
|
</script>
|
|
|
|
<!--Navigation and Symbol Display-->
|
|
|
|
<!--Google Analytics-->
|
|
|
</body>
|
</html>
|
