jdx v0.3.2

jDx

Extension for JavaScript date (format and parse)

Installation

jDx library have been tested on NodeJS and on most browsers.

On node:

npm install jdx

On browser:

<script src="/dist/js/jdx.min.js" integrity="sha384-tj1IdTxBhXxBdA0/P1vSAM86XtU0Rtl2mDdEkYk9UTDLIDq+DiodnY/IdhP2Pt/n"></script>

Usage

The library provide one item with one function to format dates and another to parse dates.

Format dates:

• jDx.formatDate(mask);

• jDx.formatDate(date[, mask [, utc]]);

• date: Provide a javascript Date object to format. Default to new Date().

• mask: The format requested can be either a name or an expression. See Patterns and Language to know more. Default is 'default'.
• utc: Boolean value, if true will display UTC time, else local time. Default is false.

var jDx = require('jdx');

jDx.formatDate(new Date()); // return 'Sun Sep 25 2016 13:06:24'
jDx.formatDate(new Date(), 'mmmm yyyy'); // return 'September 2016'
jDx.formatDate('isoUtcDateTime'); // return '2016-09-25T11:06:24Z'

Parse dates:

• jDx.parseDate(date[, mask [, utc]]);

• date: A string representing a date.

• mask: The format used by the string representation. Can be either a name or an expression. If none is provided the function will try with known pattern including previously used. See Patterns and Language to know more.
• utc: Boolean value, if true will consider date as in UTC time, else in local time. Default is false.

var jDx = require('jdx');

jDx.formatDate('Sun Sep 25 2016 13:06:24'); // equals to `Sun Sep 25 2016 13:06:24 GMT+0200`
jDx.formatDate('September 2016', 'mmmm yyyy'); // equals to `Sun Sep 01 2016 00:00:00 GMT+0200`
jDx.formatDate('2016-09-25T11:06:24Z'); // equals to `Sun Sep 25 2016 13:06:24 GMT+0200`

Patterns

The expression provide to those previous functions will recognize those patterns

• d: The day of the month.
• dd: The day of the month on two digits.
• ddd: A short representation of the day of the week (3 characters).
• dddd: The name of the day of the week.
• m: The number of the month.
• mm: The number of the month on two digits.
• mmm: A short representation of the month.
• mmmm: The name of the month.
• yy: The last two digits of the current year.
• yyyy: The year on four digits.
• h: The hours on a 12 hours clock.
• hh: The hours on a 12 hours clock on two digits.
• H: The hours on a 24 hours clock.
• HH: The hours on a 24 hours clock on two digits.
• M: The minutes.
• MM: The minutes on two digits.
• s: The seconds.
• ss: The seconds on two digits.
• l: The milliseconds on three digits.
• L: The hundreads of seconds on two digits.
• t: The meridiem (a or p)
• tt: The meridiem (am or pm)
• T: The meridiem (A or P)
• TT: The meridiem (AM or PM)
• Z: The local time offset (UTC or GMT+0000)
• o: The local time offset in minutes
• O: The local time offset in the form '+HHMM'
• S: Day of the month suffix (th, st, nd or rd).

To include extra characters, put them into quote ''.

The library alreay know some default pattern. See Languages.

Languages

The library support english as default language. However it's possible to configure the library differently.

• jDx.setLang(lang): Change the days and month names used by the library. Some pattern might change too.

Note that pattern are more localization (l10n) than internationalization (i18n) however the library is not mature enough to handle the difference perfectly but still provide way to change the formats availables.

The languages supported are: en, fr and es.

Contributing

Please report to me any bug you find. And any help is most welcome especialy for internationalization and localization.