timespan

<!DOCTYPE html> <html> <head> <title>time-span.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> time-span.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre>/* * JavaScript TimeSpan Library * * Copyright (c) 2010 Michael Stum, Charlie Robbins * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h3>Time constants</h3> </td> <td class="code"> <div class="highlight"><pre>var msecPerSecond = 1000, msecPerMinute = 60000, msecPerHour = 3600000, msecPerDay = 86400000;</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h3>Timespan Parsers</h3> </td> <td class="code"> <div class="highlight"><pre>var timeSpanWithDays = /^(\d+):(\d+):(\d+):(\d+)(\.\d+)?/, timeSpanNoDays = /^(\d+):(\d+):(\d+)(\.\d+)?/;</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h3>function TimeSpan (milliseconds, seconds, minutes, hours, days)</h3> <h4>@milliseconds {Number} Number of milliseconds for this instance.</h4> <h4>@seconds {Number} Number of seconds for this instance.</h4> <h4>@minutes {Number} Number of minutes for this instance.</h4> <h4>@hours {Number} Number of hours for this instance.</h4> <h4>@days {Number} Number of days for this instance.</h4> Constructor function for the <code>TimeSpan</code> object which represents a length of positive or negative milliseconds componentized into milliseconds, seconds, hours, and days. </td> <td class="code"> <div class="highlight"><pre>var TimeSpan = exports.TimeSpan = function (milliseconds, seconds, minutes, hours, days) { this.msecs = 0; if (isNumeric(days)) { this.msecs += (days * msecPerDay); } if (isNumeric(hours)) { this.msecs += (hours * msecPerHour); } if (isNumeric(minutes)) { this.msecs += (minutes * msecPerMinute); } if (isNumeric(seconds)) { this.msecs += (seconds * msecPerSecond); } if (isNumeric(milliseconds)) { this.msecs += milliseconds; } };</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h2>Factory methods</h2> Helper methods for creating new TimeSpan objects from various criteria: milliseconds, seconds, minutes, hours, days, strings and other <code>TimeSpan</code> instances. </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h3>function fromMilliseconds (milliseconds)</h3> <h4>@milliseconds {Number} Amount of milliseconds for the new TimeSpan instance.</h4> Creates a new <code>TimeSpan</code> instance with the specified <code>milliseconds</code>. </td> <td class="code"> <div class="highlight"><pre>exports.fromMilliseconds = function (milliseconds) { if (!isNumeric(milliseconds)) { return; } return new TimeSpan(milliseconds, 0, 0, 0, 0); }</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h3>function fromSeconds (seconds)</h3> <h4>@milliseconds {Number} Amount of seconds for the new TimeSpan instance.</h4> Creates a new <code>TimeSpan</code> instance with the specified <code>seconds</code>. </td> <td class="code"> <div class="highlight"><pre>exports.fromSeconds = function (seconds) { if (!isNumeric(seconds)) { return; } return new TimeSpan(0, seconds, 0, 0, 0); };</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <h3>function fromMinutes (milliseconds)</h3> <h4>@milliseconds {Number} Amount of minutes for the new TimeSpan instance.</h4> Creates a new <code>TimeSpan</code> instance with the specified <code>minutes</code>. </td> <td class="code"> <div class="highlight"><pre>exports.fromMinutes = function (minutes) { if (!isNumeric(minutes)) { return; } return new TimeSpan(0, 0, minutes, 0, 0); };</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <h3>function fromHours (hours)</h3> <h4>@milliseconds {Number} Amount of hours for the new TimeSpan instance.</h4> Creates a new <code>TimeSpan</code> instance with the specified <code>hours</code>. </td> <td class="code"> <div class="highlight"><pre>exports.fromHours = function (hours) { if (!isNumeric(hours)) { return; } return new TimeSpan(0, 0, 0, hours, 0); };</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <h3>function fromDays (days)</h3> <h4>@milliseconds {Number} Amount of days for the new TimeSpan instance.</h4> Creates a new <code>TimeSpan</code> instance with the specified <code>days</code>. </td> <td class="code"> <div class="highlight"><pre>exports.fromDays = function (days) { if (!isNumeric(days)) { return; } return new TimeSpan(0, 0, 0, 0, days); };</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <h3>function parse (str)</h3> <h4>@str {string} Timespan string to parse.</h4> Creates a new <code>TimeSpan</code> instance from the specified string, <code>str</code>. </td> <td class="code"> <div class="highlight"><pre>exports.parse = function (str) { var match, milliseconds; function parseMilliseconds (value) { return value ? parseFloat('0' + value) * 1000 : 0; } </pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> If we match against a full TimeSpan: </td> <td class="code"> <div class="highlight"><pre> if ((match = str.match(timeSpanWithDays))) { return new TimeSpan(parseMilliseconds(match[5]), match[4], match[3], match[2], match[1]); } </pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> If we match against a partial TimeSpan: </td> <td class="code"> <div class="highlight"><pre> if ((match = str.match(timeSpanNoDays))) { return new TimeSpan(parseMilliseconds(match[4]), match[3], match[2], match[1], 0); } return null; }; var months = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> List of default singular time modifiers and associated computation algoritm. Assumes in order, smallest to greatest performing carry forward additiona / subtraction for each Date-Time component. </td> <td class="code"> <div class="highlight"><pre>var parsers = { 'milliseconds': { exp: /(\d+)milli[second]?[s]?/i, get: function (date) { return date.getMilliseconds(date) }, set: function (val, date) { date.setMilliseconds(val) }, compute: function (delta, date, computed) { var round = delta > 0 ? Math.floor : Math.ceil; if (delta) { computed.seconds += round.call(null, delta / 1000); computed.milliseconds += delta % 1000; } if (Math.abs(computed.milliseconds) >= 1000) { computed.seconds += round.call(null, computed.milliseconds / 1000) computed.milliseconds = computed.milliseconds % 1000; } return computed; } }, 'seconds': { exp: /(\d+)second[s]?/i, get: function (date) { return date.getSeconds(date) }, set: function (val, date) { date.setSeconds(val) }, compute: function (delta, date, computed) { var round = delta > 0 ? Math.floor : Math.ceil; if (delta) { computed.minutes += round.call(null, delta / 60); computed.seconds += delta % 60; } if (Math.abs(computed.seconds) >= 60) { computed.minutes += round.call(null, computed.seconds / 60); computed.seconds = computed.seconds % 60; } return computed; } }, 'minutes': { exp: /(\d+)minute[s]?/i, get: function (date) { return date.getMinutes(date) }, set: function (val, date) { date.setMinutes(val) }, compute: function (delta, date, computed) { var round = delta > 0 ? Math.floor : Math.ceil; if (delta) { computed.hours += round.call(null, delta / 60); computed.minutes += delta % 60; } if (Math.abs(computed.minutes) >= 60) { computed.hours += round.call(null, computed.minutes / 60); computed.minutes = computed.minutes % 60; } return computed; } }, 'hours': { exp: /(\d+)hour[s]?/i, get: function (date) { return date.getHours(date) }, set: function (val, date) { date.setHours(val) }, compute: function (delta, date, computed) { var round = delta > 0 ? Math.floor : Math.ceil; if (delta) { computed.days += round.call(null, delta / 24); computed.hours += delta % 24; } if (Math.abs(computed.hours) >= 24) { computed.days += round.call(null, computed.hours / 24); computed.hours = computed.hours % 24; } return computed; } }, 'days': { exp: /(\d+)day[s]?/i, get: function (date) { return date.getDate(date) }, set: function (val, date) { date.setDate(val) }, compute: function (delta, date, computed) { var sign = delta >= 0 ? 1 : -1, opsign = delta >= 0 ? -1 : 1, clean = 0, original = delta, month = computed.months, days = months[month]; if (delta) { while (Math.abs(delta) >= days) { month += sign * 1; computed.months += sign * 1; delta += opsign * days; if (month < 0) { month = 11 } else if (month > 11) { month = 0 } days = months[month]; } computed.days += (sign * delta); } if (computed.days < 0) { clean = -1; } else if (computed.days > months[computed.months]) { clean = 1; } if (clean !== 0) { computed.months += clean; if (computed.months < 0) { computed.months = 11 } else if (computed.months > 11) { computed.months = 0 } computed.days = months[computed.months] + computed.days; } return computed; } }, 'months': { exp: /(\d+)month[s]?/i, get: function (date) { return date.getMonth(date) }, set: function (val, date) { date.setMonth(val) }, compute: function (delta, date, computed) { var round = delta > 0 ? Math.floor : Math.ceil; if (delta) { computed.years += round.call(null, delta / 12); computed.months += delta % 12; } if (computed.months > 11) { computed.years += Math.floor((computed.months + 1) / 12); computed.months = ((computed.months + 1) % 12) - 1; } return computed; } }, 'years': { exp: /(\d+)year[s]?/i, get: function (date) { return date.getFullYear(date) }, set: function (val, date) { date.setFullYear</s