This was developed to allow for the formatting of dates in JavaScript and ActionScript like PHP can do. I actually just took the documentation from the PHP date function and went down the list implementing every option that I could do easily.
Using it is simple, but you may need to refer to the available format string options often to remember how to use it. I always need to refer to PHP’s date documentation every time I use it.
- Download the latest release (zipped) and include it in your project folder
- Clone the repo:
git clone https://github.com/jacwright/date.format - Install with npm:
npm install date.format.js
Escaping letters can be done by typing \\ in front of a letter.
var myDate = new Date();
alert(myDate.format('d-m-Y')); // Outputs "26-11-2017"
alert(myDate.format('d-m-Y H:i:s')); // Outputs "26-11-2017 15:24:30"
alert(myDate.format('M jS, Y')); // Outputs "Nov 26th, 2017"
alert(myDate.format('\\T\\o\\d\\a\\y \\i\\s d-m-Y')); // Outputs "Today is 26-11-2017"Include your preferred locale.js from the locales folder and require it before you require date.format.
<script src="locale.js"></script>
<script src="date.format.min.js"></script>Localization is supported for the following identifiers:
Taken from PHP's date(); function and modified.
| Format character | Description | Output |
|---|---|---|
| Day | ||
| d | Day of the month, 2 digits with leading zeros | 01 to 31 |
| D | A textual representation of a day, three letters | Mon through Sun |
| j | Day of the month without leading zeros | 1 to 31 |
| l (lowercase L) | A full textual representation of the day of the week | Sunday through Saturday |
| N | ISO-8601 numeric representation of the day of the week | 1 (for Monday) through 7 (for Sunday) |
| S | English ordinal suffix for the day of the month, 2 characters | st, nd, rd or th. Works well with j |
| w | Numeric representation of the day of the week | 0 (for Sunday) through 6 (for Saturday) |
| z | The day of the year (starting from 0) | 0 through 365 |
| Week | ||
| W | ISO-8601 week number of year, weeks starting on Monday | Example: 42 (the 42nd week in the year) |
| Month | ||
| F | A full textual representation of a month, such as January or March | January through December |
| m | Numeric representation of a month, with leading zeros | 01 through 12 |
| M | A short textual representation of a month, three letters | Jan through Dec |
| n/a> | Numeric representation of a month, without leading zeros | 1 through 12 |
| t | Number of days in the given month | 28 through 31 |
| Year | ||
| L | Whether it’s a leap year | 1 if it is a leap year, 0 otherwise. |
| o | ISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. | Examples: 1999 or 2003 |
| Y | A full numeric representation of a year, 4 digits | Examples: 1999 or 2003 |
| y | A two digit representation of a year | Examples: 99 or 03 |
| Time | ||
| a | Lowercase Ante meridiem or Post meridiem | am or pm |
| A | Uppercase Ante meridiem or Post meridiem | AM or PM |
| B | Swatch Internet time | 000 through 999 |
| g | 12-hour format of an hour without leading zeros | 1 through 12 |
| G | 24-hour format of an hour without leading zeros | 0 through 23 |
| h | 12-hour format of an hour with leading zeros | 01 through 12 |
| H | 24-hour format of an hour with leading zeros | 00 through 23 |
| i | Minutes with leading zeros | 00 to 59 |
| s | Seconds, with leading zeros | 00 through 59 |
| v | Milliseconds | Example: 654 |
| Timezone | ||
| e | Timezone identifier | Atlantic/Azorest or Europe/Amsterdam |
| I (capital i) | Whether or not the date is in daylights savings time | 1 if Daylight Savings Time, 0 otherwise. |
| O (capital o) | Difference to Greenwich time (GMT) in hours | Example: +0200 |
| P | Difference to Greenwich time (GMT) with colon between hours and minutes | Example: +02:00 |
| T | Timezone setting of this machine | Examples: EST or MDT |
| Z | Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. | -43200 through 43200 |
| Full Date/Time | ||
| c | ISO 8601 formatted date | Example: 2017-11-26T15:12:21+00:00 |
| r | RFC 2822 formatted date | Example: Thu, 21 Dec 2000 16:01:07 +0200 |
| U | Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | Example: 1501804996 |
Date.format is an open-source library and we would love for you to contribute! Head over to CONTRIBUTING.md.