readme.md

Time Traveller

A library to work with date and time.

Purpose

Time traveller is my attempt to provide a better api to work with date and time operations. My hope is to grow this library to make working with dates as enjoyable as possible.

Objects

TimeTraveller

Factory object to extend Date with some utility methods to do comparison and perform common operations on dates.

As of version 0.2.1 only has a now() factory method that's equivalent to doing new Date().

The returned date object is enhanced with some utility methods as described below.

add methods

The available add methods are:

addYears
addMonths
addDays
addHours
addMinutes
addSeconds
addMilliseconds

These methods can take either a positive or a negative number. A negative number will result in the substraction of the given period.

For example:

var d = new TimeTraveller().now(); 
console.log(d); //Mon, 04 Jul 2011 23:03:22 GMT
d.addYears(2);
console.log(d); //Thu, 04 Jul 2013 23:03:22 GMT
d.addYears(-4);
console.log(d); //Thu, 04 Jul 2009 23:03:22 GMT

isSame methods

There is a main isSame method that takes and can also have a single character that indicates precision.

var d = new TimeTraveller().now();

There are also methods for every precision that make a cleaner API.

isSameSecond
isSameMinute
isSameHour
isSameDay
isSameMonth
isSameYear
isSame

TimeSpan

A simple object tha represents a period of time. As of version 0.2.1 a TimeSpan object can be created in 3 ways.

Calling the differenceFrom(secondDate) method on an enhanced Date object.

var d = new TimeTraveller().now();
var ts = d.differenceFrom(new Date());

Passing milliseconds into the constructor:

var ts = new TimeSpan(1300);

Passing two dates into the contructor

var ts = new TimeSpan(date, secondDate);