Underscore.date is a javascript date library that helps create, manipulate, and format dates without extending the Date prototype.
Author: Tim Wood
Version: 0.5.0
Note: There are some api changes that will break your code when upgrading from 0.4.1 to 0.5.0. Read about the changes in the changelog at the bottom of the page.
1.82 kb (min + gzip)
Where to use it
Node.js
Install with npm
npm install underscore.date
Usage
var _date = require('underscore.date');console.log(_date('September 9 1999').fromNow());
In the browser
If underscore exists, underscore.date will mix itself into the underscore namespace, so you can use as you would use an underscore function.
_.date('September 9 1999').fromNow();
Otherwise, you should use _date.
_date('September 9 1999').fromNow();
_date()
The library works by creating a _date() wrapper object. To create that wrapper, you can pass any of the following data types in.
Number
_date(1300291340510)
An integer value representing the number of milliseconds since 1 January 1970 00:00:00 UTC.
A string and a format string. The second string will be used as the format to parse the first string.
The format parts are similar to the formats from _date().format()
Important: Parsing a string with a format is by far the slowest method of creating a date.
If you have the ability to change the input, it is much faster (~15x) to use Unix timestamps.
Input
Output
M or MM
Month
D or DD
Day of month
DDD or DDDD
Day of year
YY
2 digit year (if greater than 70, will return 1900's, else 2000's)
YYYY
4 digit year
a or A
AM/PM
H, HH, h, or hh
24 hour (for 12 hour time, use in conjunction with a or A)
m or mm
Minutes
s or ss
Seconds
_date Prototype
underscore.date contains a number of utility functions for manipulating and formatting dates.
_date.add()
_date.add(object)
Adds time per the object passed in.
The object should have key value pairs as shown below.
{ ms : 200, // milliseconds s : 10, // seconds m : 10, // minutes (note: lowercase) h : 2, // hours d : 3, // days M : 2, // months (note: uppercase) y : 3 // years}
All the parameters are optional. Also, there are no upper limits for the values, so you can overload any of the parameters.
{ ms : 1000000 } // a million milliseconds{ d : 360 } // 360 days
Special considerations for months and years
If the day of the month on the original date is greater than the number of days in the final month, the day of the month will change to the last day in the final month.
Example:
_date([2010, 0, 31]) // January 31_date([2010, 0, 31]).add({M : 1}) // February 28
_date.subtract()
_date.subtract(object)
Functions the same as _date.add(), only using subtraction instead of addition.
Example:
_date([2010, 1, 28]) // February 28_date([2010, 1, 28]).subtract({M:1}) // January 28
_date.format()
_date.format(string)
Returns a human readable string based on the format string that was passed in.
var dateToFormat = new Date(2010, 1, 14, 15, 25, 50, 125);_date(dateToFormat).format("dddd, MMMM Do YYYY, h:mm:ss a"); // "Sunday, February 14th 2010, 3:25:50 pm"_date(dateToFormat).format("ddd, hA"); // "Sun, 3PM"
The formats are created by creating a string of replacable characters.
Input
Output
Month
M
1 2 ... 11 12
Mo
1st 2nd ... 11th 12th
MM
01 02 ... 11 12
MMM
Jan Feb ... Nov Dec
MMMM
January February ... November December
Day of Month
D
1 2 ... 30 30
Do
1st 2nd ... 30th 31st
DD
01 02 ... 30 31
Day of Year
DDD
1 2 ... 364 365
DDDo
1st 2nd ... 364th 365th
DDDD
001 002 ... 364 365
Day of Week
d
0 1 ... 5 6
do
0th 1st ... 5th 6th
ddd
Sun Mon ... Fri Sat
dddd
Sunday Monday ... Friday Saturday
Week of Year
w
1 2 ... 52 53
wo
1st 2nd ... 52nd 53rd
ww
01 02 ... 52 53
Year
YY
70 71 ... 29 30
YYYY
1970 1971 ... 2029 2030
AM/PM
A
AM PM
a
am pm
Hour
H
0 1 ... 22 23
HH
00 01 ... 22 23
h
1 2 ... 11 12
hh
01 02 ... 11 12
Minute
m
0 1 ... 58 59
mm
00 01 ... 58 59
Second
s
0 1 ... 58 59
ss
00 01 ... 58 59
Timezone
z
EST CST ... MST PST
zz
Eastern Standard Time ... Pacific Standard Time
NOTE: Internet Explorer uses a different implementation of
Date.toString(), so we are unable to retrieve the full string
of the timezone, and will fall back to 'z'.
So:
Firefox, Chrome, Safari, etc. == 'Eastern Standard Time'
Internet Explorer, etc. == 'EST'
Returns a string as relative time ('minutes ago', '5 months ago', etc).
You can pass anything that you would pass to _date() as the first parameter, or a _date() object.
_date([2007, 0, 29]).from(_date([2007, 0, 28])) // "a day ago"
You can pass true as the second parameter to return without the prefixes and suffixes.
_date([2007, 0, 29]).from(_date([2007, 0, 28]), true) // "a day"
You can pass true as the third parameter to return as milliseconds.
The number of milliseconds returned will be positive if the date passed
in is later than the first date, and negative if the date passed in is earlier.
To customize the wording of _date.format() and _date.from(), the strings are exposed through the _date object. You can modify these however you see fit.
Examples :
_date.relativeTime.future = "%s from now";_date.relativeTime.past = "%s in the past";
_date.relativeTime
_date.relativeTime = { future: "in %s", past: "%s ago", s: "seconds", m: "a minute", mm: "%d minutes", h: "an hour", hh: "%d hours", d: "a day", dd: "%d days", M: "a month", MM: "%d months", y: "a year", yy: "%d years"};
The strings used in _date.from().
future and past are used as the suffixes/prefixes.
For all these values, a single character refers to the singular, and an double character refers to the plural.
Underscore.date is freely distributable under the terms of the MIT license.
Changelog
0.5.0
Dropped the redundant _date.date() in favor of _date().
Removed _date.now(), as it is a duplicate of _date() with no parameters.
Removed _date.isLeapYear(yearNuumber). Use _date([yearNumber]).isLeapYear() instead.
Exposed customization options through the _date.relativeTime, _date.weekdays, _date.weekdaysShort, _date.months, _date.monthsShort, and _date.ordinal variables instead of the _date.customize() function.
0.4.1
Added date input formats for input strings.
0.4.0
Added underscore.date to npm. Removed dependancies on underscore.
0.3.2
Added 'z' and 'zz' to _.date().format(). Cleaned up some redundant code to trim off some bytes.
0.3.1
Cleaned up the namespace. Moved all date manipulation and display functions to the _.date() object.
0.3.0
Switched to the Underscore methodology of not mucking with the native objects' prototypes.
Made chaining possible.
0.2.1
Changed date names to be a more pseudo standardized 'dddd, MMMM Do YYYY, h:mm:ss a'.
Added Date.prototype functions add, subtract, isdst, and isleapyear.
0.2.0
Changed function names to be more concise.
Changed date format from php date format to custom format.