Update: The documentation below has been updated for the new Date Format 1.2. Get it now!
Although JavaScript provides a bunch of methods for getting and setting parts of a date object, it lacks a simple way to format dates and times according to a user-specified mask. There are a few scripts out there which provide this functionality, but I've never seen one that worked well for me… Most are needlessly bulky or slow, tie in unrelated functionality, use complicated mask syntaxes that more or less require you to read the documentation every time you want to use them, or don't account for special cases like escaping mask characters within the generated string.
When choosing which special mask characters to use for my JavaScript date formatter, I looked at PHP's date function and ColdFusion's discrete dateFormat and timeFormat functions. PHP uses a crazy mix of letters (to me at least, since I'm not a PHP programmer) to represent various date entities, and while I'll probably never memorize the full list, it does offer the advantages that you can apply both date and time formatting with one function, and that none of the special characters overlap (unlike ColdFusion where m
and mm
mean different things depending on whether you're dealing with dates or times). On the other hand, ColdFusion uses very easy to remember special characters for masks.
With my date formatter, I've tried to take the best features from both, and add some sugar of my own. It did end up a lot like the ColdFusion implementation though, since I've primarily used CF's mask syntax.
Before getting into further details, here are some examples of how this script can be used:
var now = new Date(); now.format("m/dd/yy"); // Returns, e.g., 6/09/07 // Can also be used as a standalone function dateFormat(now, "dddd, mmmm dS, yyyy, h:MM:ss TT"); // Saturday, June 9th, 2007, 5:46:21 PM // You can use one of several named masks now.format("isoDateTime"); // 2007-06-09T17:46:21 // ...Or add your own dateFormat.masks.hammerTime = 'HH:MM! "Can\'t touch this!"'; now.format("hammerTime"); // 17:46! Can't touch this! // When using the standalone dateFormat function, // you can also provide the date as a string dateFormat("Jun 9 2007", "fullDate"); // Saturday, June 9, 2007 // Note that if you don't include the mask argument, // dateFormat.masks.default is used now.format(); // Sat Jun 09 2007 17:46:21 // And if you don't include the date argument, // the current date and time is used dateFormat(); // Sat Jun 09 2007 17:46:22 // You can also skip the date argument (as long as your mask doesn't // contain any numbers), in which case the current date/time is used dateFormat("longTime"); // 5:46:22 PM EST // And finally, you can convert local time to UTC time. Either pass in // true as an additional argument (no argument skipping allowed in this case): dateFormat(now, "longTime", true); now.format("longTime", true); // Both lines return, e.g., 10:46:21 PM UTC // ...Or add the prefix "UTC:" to your mask. now.format("UTC:h:MM:ss TT Z"); // 10:46:21 PM UTC
Following are the special characters supported. Any differences in meaning from ColdFusion's dateFormat
and timeFormat
functions are noted.
Mask | Description |
---|---|
d |
Day of the month as digits; no leading zero for single-digit days. |
dd |
Day of the month as digits; leading zero for single-digit days. |
ddd |
Day of the week as a three-letter abbreviation. |
dddd |
Day of the week as its full name. |
m |
Month as digits; no leading zero for single-digit months. |
mm |
Month as digits; leading zero for single-digit months. |
mmm |
Month as a three-letter abbreviation. |
mmmm |
Month as its full name. |
yy |
Year as last two digits; leading zero for years less than 10. |
yyyy |
Year represented by four digits. |
h |
Hours; no leading zero for single-digit hours (12-hour clock). |
hh |
Hours; leading zero for single-digit hours (12-hour clock). |
H |
Hours; no leading zero for single-digit hours (24-hour clock). |
HH |
Hours; leading zero for single-digit hours (24-hour clock). |
M |
Minutes; no leading zero for single-digit minutes. Uppercase M unlike CF timeFormat 's m to avoid conflict with months. |
MM |
Minutes; leading zero for single-digit minutes. Uppercase MM unlike CF timeFormat 's mm to avoid conflict with months. |
s |
Seconds; no leading zero for single-digit seconds. |
ss |
Seconds; leading zero for single-digit seconds. |
l or L |
Milliseconds. l gives 3 digits. L gives 2 digits. |
t |
Lowercase, single-character time marker string: a or p. No equivalent in CF. |
tt |
Lowercase, two-character time marker string: am or pm. No equivalent in CF. |
T |
Uppercase, single-character time marker string: A or P. Uppercase T unlike CF's t to allow for user-specified casing. |
TT |
Uppercase, two-character time marker string: AM or PM. Uppercase TT unlike CF's tt to allow for user-specified casing. |
Z |
US timezone abbreviation, e.g. EST or MDT. With non-US timezones or in the Opera browser, the GMT/UTC offset is returned, e.g. GMT-0500 No equivalent in CF. |
o |
GMT/UTC timezone offset, e.g. -0500 or +0230. No equivalent in CF. |
S |
The date's ordinal suffix (st, nd, rd, or th). Works well with d .No equivalent in CF. |
'…' or "…" |
Literal character sequence. Surrounding quotes are removed. No equivalent in CF. |
UTC: |
Must be the first four characters of the mask. Converts the date from local time to UTC/GMT/Zulu time before applying the mask. The "UTC:" prefix is removed. No equivalent in CF. |
And here are the named masks provided by default (you can easily change these or add your own):
Name | Mask | Example |
---|---|---|
default | ddd mmm dd yyyy HH:MM:ss | Sat Jun 09 2007 17:46:21 |
shortDate | m/d/yy | 6/9/07 |
mediumDate | mmm d, yyyy | Jun 9, 2007 |
longDate | mmmm d, yyyy | June 9, 2007 |
fullDate | dddd, mmmm d, yyyy | Saturday, June 9, 2007 |
shortTime | h:MM TT | 5:46 PM |
mediumTime | h:MM:ss TT | 5:46:21 PM |
longTime | h:MM:ss TT Z | 5:46:21 PM EST |
isoDate | yyyy-mm-dd | 2007-06-09 |
isoTime | HH:MM:ss | 17:46:21 |
isoDateTime | yyyy-mm-dd'T'HH:MM:ss | 2007-06-09T17:46:21 |
isoUtcDateTime | UTC:yyyy-mm-dd'T'HH:MM:ss'Z' | 2007-06-09T22:46:21Z |
A couple issues:
- In the unlikely event that there is ambiguity in the meaning of your mask (e.g.,
m
followed bymm
, with no separating characters), put a pair of empty quotes between your metasequences. The quotes will be removed automatically. - If you need to include literal quotes in your mask, the following rules apply:
- Unpaired quotes do not need special handling.
- To include literal quotes inside masks which contain any other quote marks of the same type, you need to enclose them with the alternative quote type (i.e., double quotes for single quotes, and vice versa). E.g.,
date.format('h "o\'clock, y\'all!"')
returns "6 o'clock, y'all". This can get a little hairy, perhaps, but I doubt people will really run into it that often. The previous example can also be written asdate.format("h") + "o'clock, y'all!"
.
Here's the code:
/* * Date Format 1.2.3 * (c) 2007-2009 Steven Levithan <stevenlevithan.com> * MIT license * * Includes enhancements by Scott Trenda <scott.trenda.net> * and Kris Kowal <cixar.com/~kris.kowal/> * * Accepts a date, a mask, or a date and a mask. * Returns a formatted version of the given date. * The date defaults to the current date/time. * The mask defaults to dateFormat.masks.default. */ var dateFormat = function () { var token = /d{1,4}|m{1,4}|yy(?:yy)?|([HhMsTt])\1?|[LloSZ]|"[^"]*"|'[^']*'/g, timezone = /\b(?:[PMCEA][SDP]T|(?:Pacific|Mountain|Central|Eastern|Atlantic) (?:Standard|Daylight|Prevailing) Time|(?:GMT|UTC)(?:[-+]\d{4})?)\b/g, timezoneClip = /[^-+\dA-Z]/g, pad = function (val, len) { val = String(val); len = len || 2; while (val.length < len) val = "0" + val; return val; }; // Regexes and supporting functions are cached through closure return function (date, mask, utc) { var dF = dateFormat; // You can't provide utc if you skip other args (use the "UTC:" mask prefix) if (arguments.length == 1 && Object.prototype.toString.call(date) == "[object String]" && !/\d/.test(date)) { mask = date; date = undefined; } // Passing date through Date applies Date.parse, if necessary date = date ? new Date(date) : new Date; if (isNaN(date)) throw SyntaxError("invalid date"); mask = String(dF.masks[mask] || mask || dF.masks["default"]); // Allow setting the utc argument via the mask if (mask.slice(0, 4) == "UTC:") { mask = mask.slice(4); utc = true; } var _ = utc ? "getUTC" : "get", d = date[_ + "Date"](), D = date[_ + "Day"](), m = date[_ + "Month"](), y = date[_ + "FullYear"](), H = date[_ + "Hours"](), M = date[_ + "Minutes"](), s = date[_ + "Seconds"](), L = date[_ + "Milliseconds"](), o = utc ? 0 : date.getTimezoneOffset(), flags = { d: d, dd: pad(d), ddd: dF.i18n.dayNames[D], dddd: dF.i18n.dayNames[D + 7], m: m + 1, mm: pad(m + 1), mmm: dF.i18n.monthNames[m], mmmm: dF.i18n.monthNames[m + 12], yy: String(y).slice(2), yyyy: y, h: H % 12 || 12, hh: pad(H % 12 || 12), H: H, HH: pad(H), M: M, MM: pad(M), s: s, ss: pad(s), l: pad(L, 3), L: pad(L > 99 ? Math.round(L / 10) : L), t: H < 12 ? "a" : "p", tt: H < 12 ? "am" : "pm", T: H < 12 ? "A" : "P", TT: H < 12 ? "AM" : "PM", Z: utc ? "UTC" : (String(date).match(timezone) || [""]).pop().replace(timezoneClip, ""), o: (o > 0 ? "-" : "+") + pad(Math.floor(Math.abs(o) / 60) * 100 + Math.abs(o) % 60, 4), S: ["th", "st", "nd", "rd"][d % 10 > 3 ? 0 : (d % 100 - d % 10 != 10) * d % 10] }; return mask.replace(token, function ($0) { return $0 in flags ? flags[$0] : $0.slice(1, $0.length - 1); }); }; }(); // Some common format strings dateFormat.masks = { "default": "ddd mmm dd yyyy HH:MM:ss", shortDate: "m/d/yy", mediumDate: "mmm d, yyyy", longDate: "mmmm d, yyyy", fullDate: "dddd, mmmm d, yyyy", shortTime: "h:MM TT", mediumTime: "h:MM:ss TT", longTime: "h:MM:ss TT Z", isoDate: "yyyy-mm-dd", isoTime: "HH:MM:ss", isoDateTime: "yyyy-mm-dd'T'HH:MM:ss", isoUtcDateTime: "UTC:yyyy-mm-dd'T'HH:MM:ss'Z'" }; // Internationalization strings dateFormat.i18n = { dayNames: [ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], monthNames: [ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec", "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }; // For convenience... Date.prototype.format = function (mask, utc) { return dateFormat(this, mask, utc); };
Download it here (1.2 KB when minified and gzipped).
Note that the day and month names can be changed (for internationalization or other purposes) by updating the dateFormat.i18n
object.
If you have any suggestions or find any issues, lemme know.
Want to learn about aphantasisa and hyperphantasia, the Shen Yun cult, or unmasking cult leader Karen Zerby? Check out my new blog at Life After Tech.
Very nice. Thanks.
what r u mention in this blog all are wrong
your right Ajay Verma… this blog all wrong!
Hello Steven,
I used
xaxis_value = dateFormat(‘Apr 1 2011’, ‘yyyy-mmm’);
Output: April 1st
But it doesn’t work. Can you guide me how to correct?
Thanks,
Quang
Hello
Very interesting Steven.
I don’t want to use it in a separate file but I want to include it in my library and customize it. Is there any restriction? I’m familiar to license terms.
I’m waiting your answer.
thanks
I’m confused, how do you get this to output to an html element on screen. Nothing seems to be formatted when I use this script:
var d = new Date();
d.format(“mmmm dS, yyyy – h:MM TT”);
document.getElementById(“time”).innerHTML=d;
Mike – you’re confused here by what the format() method is doing. It doesn’t modify the underlying Date object at all, it just processes the Date object’s properties into the format string. If you want to do something with the formatted string, you need to do that with the result of the method call. Like this:
document.getElementById(“time”).innerHTML = (new Date).format(“mmmm dS, yyyy โ h:MM TT”);
Steve – I found a bug in the L processing. It’s small and likely insignificant, but incorrect nonetheless. If L < 100, then it will be output literally to the result, but without any sort of leading zeros, altering its value in the decimal place. So 99ms and 990ms will end up showing as the same L value. If you want L to always be 2 decimal places, then you need to use pad(Math.round(L / 10)). Personally I’d prefer that L stand for “milliseconds with no trailing zeros”, in which case you’d just use String(L).replace(/0+$/, “”). Your choice, but I’d recommend fixing it one way or the other before long.
Oh, and I know it’s been over two years since it was released, but congratulations on your O’Reilly book! ๐ And I never noticed the “Powered by Vodka โข Red Bull” links in the bottom of your site – I’m a Red Bull fiend as well. ๐
This prototype is really nice, Steven. Thanks for posting it. I’ll be using it shortly on this lottery page: http://www.projo.com/lottery
Hi can any convert the date into this format…
CYYD to mm/dd
CYMD is century year month date
Example: 1,110601 to 6/01 //(jun 1st)
I need a code for “yymmdd” type dates..help me
I found your code today – great! Just what i needed.
However, it appears that the input date parameter does not like having a date ordinal suffix (st, nd, rd, or th).
This works: dateFormat(‘Sat, Jun 11, 2011 10:30 am, EDT’,’mmm-dd-yyyy HH:MMTT’);
This does not work: dateFormat(‘Sat, Jun 11th, 2011 10:30 am, EDT’,’mmm-dd-yyyy HH:MMTT’);
thanks!
While i can strip the ordinal sufix out, it would be nice not to have to.
Hi,
It’s great to finally find a workable JavaScript lib for dates. However, I seem to be having some problems with the format: dd/mm/yyyy, it appears to format it as mm/dd/yyyy. I have written the following simple test, which if you enter say 10/02/2011 it comes out as 02/10/2011. I guess I’m just misunderstanding something.
Any advice would be welcome.
Thanks,
Kaine
<html>
<head>
<title></title>
<script language=”javascript” type=”text/javascript” src=”date.format.js”></script>
<script language=”javascript” type=”text/javascript”>
function CheckDate(ctrl, format)
{
try
{
var dte = dateFormat(ctrl.value, format);
if (dte == ctrl.value)
writeResponse(“Match: dte:” + dte + “, ctrl:” + ctrl.value);
else
writeResponse(“Unmatched: dte:” + dte + “, ctrl:” + ctrl.value);
}
catch (e) { writeResponse(“Error:=” + e.Description); }
}
function writeResponse(msg) { document.getElementById(“response”).innerHTML = msg; }
</script>
</head>
<body>
<form id=”form1″>
<div>
<input type=”text” class=”date” onkeyup=”CheckDate(this, ‘dd/mm/yyyy’);” /><span> (dd/mm/yyyy)</span>
</div>
<div><span id=”response”></span></div>
</form>
</body>
</html>
Hi,
When I test using the test harness above in IE, with a date such as 21/11/1968 comes back as 11/09/1969.
I have tested it using IE9, IE8 (IE9 compatibility) and IE7 (IE9 compatibility), and in each case, 11/09/1969 is returned.
Does this mean that the script isn’t compatible with IE?
Cheers,
Kaine
P.S. – I have found that if I instantiate a new Date object using the dte variable in the constructor, and then call the .format(format) method, I can get the date back to my desired format in Firefox.
Hi,
To add to my previous comment, the date 21/11/1968 also formats to 11/09/1969 in both Firefox and Opera as well.
In Chrome I get a ‘SyntaxError: invalid date’ error. It is difficult to see what the problem is with Safari, but I suspect that it is encountering the same issue as Chrome.
Perhaps I’m using the library incorrectly? I’d be grateful for some advice.
Cheers,
Kaine
Thanks for the code dude.
This was really helpful for me.
Thanks!! it helped!!
A million THANKS !!!!!!!
Hi,
Thanks in advance for your time, please solve my following issue if possible…
I have 2 files… 1 is html which is time counter and second one is showing registered user date and time… example : user registered with us july 16, 2011 20:00:00 and after 10 days they can upload or download free files — in member tpl file showing date in this format {$data[0].registration_date|date_format:”%d/%m/%Y”}, but in html counter file is like :
var refDate = new Date(“july 16, 2011 20:00:00″); // start date;
if I write {$data[0].registration_date|date_format:”%d/%m/%Y”} in start date there is error…. and result NnNn etc.
if you like I can send you files for further ….
Thanks again for your time and sorry about my English if any mistake…
Very nice script man, saved me a lot of hassel. Is it ok if i attach a link to this post from my blog
Very nice function! Very well-rounded. You have made my life a lot easier. Thanks!
Awesome script man. It does exactly as I wanted it. Thanks alot dude. ๐
var DateTime = {
ShortMonths: new Array(“Jan”, “Feb”, “Mar”, “Apr”, “May”, “Jun”, “Jul”, “Aug”, “Sep”, “Oct”, “Nov”, “Dec”),
LongMonths: new Array(“January”, “February”, “March”, “April”, “May”, “June”, “July”, “August”, “September”, “October”, “November”, “December”),
ShortDays: new Array(“Sun”, “Mon”, “Tue”, “Wed”, “Thu”, “Fri”, “Sat”),
LongDays: new Array(“Sunday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”),
SuperScript: function (day) {
if ((/^(1|21|31)$/).test(day))
return “st”;
else if ((/^(2|22)$/).test(day))
return “nd”;
else if ((/^(3|23)$/).test(day))
return “rd”;
else
return “th”;
},
FormatDate: function (_d, regexp) {
regexp = regexp.replace(/y/g, “g”);
regexp = regexp.replace(/M/g, “k”);
regexp = regexp.replace(/d/g, “q”);
regexp = regexp.replace(/h/g, “x”);
regexp = regexp.replace(/m/g, “z”);
var dddd = this.LongDays[_d.getDay()];
var ddd = this.ShortDays[_d.getDay()];
var dd = ((_d.getDate() < 10) ? "0" : "") + _d.getDate();
var d = _d.getDate();
var a = this.SuperScript(_d.getDate());
var MMMM = this.LongMonths[_d.getMonth()];
var MMM = this.ShortMonths[_d.getMonth()];
var MM = ((_d.getMonth() < 10) ? "0" : "") + _d.getMonth();
var M = _d.getMonth();
var yyyy = _d.getFullYear();
var yy = yyyy.toString().substring(2);
regexp = regexp.replace("qqqq", dddd);
regexp = regexp.replace("qqq", ddd);
regexp = regexp.replace("qq", dd);
regexp = regexp.replace("q", d);
regexp = regexp.replace("a", a);
regexp = regexp.replace("kkkk", MMMM);
regexp = regexp.replace("kkk", MMM);
regexp = regexp.replace("kk", MM);
regexp = regexp.replace("k", M);
regexp = regexp.replace("gggg", yyyy);
regexp = regexp.replace("gg", yy);
return regexp;
}
}
opps. you will have to put the following line above the line
regexp = regexp.replace(“qqqq”, dddd);
regexp = regexp.replace(“a”, a);
Awesome this script saved me a ton of time.
Great contribution! Is there a closure based implementation? We’re refactoring a legacy app and one of our goals is to minimize attaching objects to the global namespace.
Thank you for your script. It is amazing that there are no built-in JavaScript functions.
I don’t see a PayPal ‘donate’ button. This script saved me tons of time. Thanks a lot.
Thanks, Thanks. ๐
Great code. Small and pluggable.
thx, save me a lot of time.
Hello Everyone,
We can use Date () object to manipulate dates in java script. Whenever we want to access current date of the system or want to set new date in java script then we can use appropriate java script method of date function. In this demonstration we learn how to work with function of date object………….
Please check out this link for more details ……..
http://mindstick.com/Articles/c18de1aa-fd9c-433a-80ea-93c14522c856/?Implementing%20Date%20object%20in%20Java%20Script
Thanks !!!
Hi,
Thanx for your script. Its really helpful, i am using this script from 2008 ๐
Thank you. Great script, great documentation. Thanks a lot.
Steven . . .
Thank you so much for this. I have been wrestling with formatting dates in JavaScript for some time. This function is extremely helpful.
Just one issue that I found (frankly for most needs its a non-issue). When attempting to format a date that has a three digit year to four digits, I would expect the leading zero in the year.
Example: var sDateString = dateFormat(new Date(266,2,3),’mm/dd/yyyy’); i would expect it to return ’03/03/0266′. Instead it returns ’03/03/266′. (JavaScript months are zero based, whether I like it or not . . . and I don’t.)
Anyway . . . this is, undoubtedly, a non-issue for most developers. I just thought you might like to know for completeness sake.
Thanks again for an awesome piece of code!
Doug
Good guy! From Brazil!
Thanks. Saved me lot of time.
La migliore informazione essenziale รจ questo, che si cerca di fare molto bene in avvicinamento per quel corpo senza fissa dimora e la loro mano. Sono cosรฌ ispirato a tale proposito, dopo aver letto questa tua articoli utili scritti e le vostre opinioni anche che รจ cosรฌ attraente per fare qualcosa per quei
Please, _please_ don’t modify built-ins “for convienence”. This doesn’t serve anything and leads to conflicts, which people then complain about.
Steve
If my input string is “19/1/2010” as in European format, it does not give me the desired result. The 19 is converted to the month 7 and the date is parsed as 7/1/2010. Any suggestions?
@Steve:
You are the hero of the Day,
thank you very much for your work!
If you’d know of how much time and problems you saved me ๐
I didn’t think it would be such a pain in the a$$ getting a formated UTC Output in JS, but now it is no problem anymore ๐
greets from Italy
-SnowSky
The isoDate doesn’t seem to be consistent.
If I write as follow,
var date = new Date();
date.format(“isoDate”,true);
It prints the date of yesterday(not today).
Hello there,
Thank you for your script! It really helped me today ๐
I am putting it in my default script list for my projects!
Strange, milliseconds (l and L) work in Firefox and Chrome, but not in IE (9).
dateFormat(new Date(), “yyyy/mm/dd hh:MM:ss L l”) + ” getMilliseconds(): ” + new Date().getMilliseconds();
result:
2012/01/27 02:52:33 00 000 getMilliseconds(): 545
both l and L always return 0
Fantastic code!!
Great job.
I love it when a plan comes together. And this was well done!
Thanks
saved my day ! thx
Need to clarify.Code examples or methods provided on this article will work as a part of the web page. But if you want to use it in standalone JS file(for example to execute as part of BATCH job) – good luck Charlie.
Thanks. I just made a code like this:
return time.getFullYear().toString() + ‘-‘ +
((time.getMonth()+1) < 11 ? ('0' + (time.getMonth()+1)) : time.getMonth()+1 )+ '-' +
((time.getDay()) < 11 ? ('0' + (time.getDay())) : time.getDay() ) + ' ' +
((time.getHours()) < 11 ? ('0' + (time.getHours())) : time.getHours() ) + ':' +
((time.getMinutes()) < 11 ? ('0' + (time.getMinutes())) : time.getMinutes() ) + ':' +
((time.getSeconds()) < 11 ? ('0' + (time.getSeconds())) : time.getSeconds() );
.
Good job.