Intl.DateTimeFormat
The Intl.DateTimeFormat
object enables language-sensitive date and time formatting.
Constructor
Intl.DateTimeFormat()
-
Creates a new
Intl.DateTimeFormat
object.
Static methods
Intl.DateTimeFormat.supportedLocalesOf()
-
Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.
Instance methods
Intl.DateTimeFormat.prototype.format()
-
Getter function that formats a date according to the locale and formatting options of this
DateTimeFormat
object. Intl.DateTimeFormat.prototype.formatToParts()
-
Returns an
Array
of objects representing the date string in parts that can be used for custom locale-aware formatting. Intl.DateTimeFormat.prototype.resolvedOptions()
-
Returns a new object with properties reflecting the locale and formatting options computed during initialization of the object.
Intl.DateTimeFormat.prototype.formatRange()
-
This method receives two Dates and formats the date range in the most concise way based on the locale and options provided when instantiating
DateTimeFormat
. Intl.DateTimeFormat.prototype.formatRangeToParts()
-
This method receives two Dates and returns an Array of objects containing the locale-specific tokens representing each part of the formatted date range.
Examples
Using DateTimeFormat
In basic use without specifying a locale, DateTimeFormat
uses the default locale and default options.
var date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// toLocaleString without arguments depends on the implementation,
// the default locale, and the default time zone
console.log(new Intl.DateTimeFormat().format(date));
// → "12/19/2012" if run with en-US locale (language) and time zone America/Los_Angeles (UTC-0800)
Using locales
This example shows some of the variations in localized date and time formats. In order to get the format of the language used in the user interface of your application, make sure to specify that language (and possibly some fallback languages) using the locales
argument:
var date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0));
// Results below use the time zone of America/Los_Angeles (UTC-0800, Pacific Standard Time)
// US English uses month-day-year order
console.log(new Intl.DateTimeFormat('en-US').format(date));
// → "12/19/2012"
// British English uses day-month-year order
console.log(new Intl.DateTimeFormat('en-GB').format(date));
// → "19/12/2012"
// Korean uses year-month-day order
console.log(new Intl.DateTimeFormat('ko-KR').format(date));
// → "2012. 12. 19."
// Arabic in most Arabic speaking countries uses real Arabic digits
console.log(new Intl.DateTimeFormat('ar-EG').format(date));
// → "١٩/١٢/٢٠١٢"
// for Japanese, applications may want to use the Japanese calendar,
// where 2012 was the year 24 of the Heisei era
console.log(new Intl.DateTimeFormat('ja-JP-u-ca-japanese').format(date));
// → "24/12/19"
// when requesting a language that may not be supported, such as
// Balinese, include a fallback language, in this case Indonesian
console.log(new Intl.DateTimeFormat(['ban', 'id']).format(date));
// → "19/12/2012"
Using options
The date and time formats can be customized using the options
argument:
var date = new Date(Date.UTC(2012, 11, 20, 3, 0, 0, 200));
// request a weekday along with a long date
var options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };
console.log(new Intl.DateTimeFormat('de-DE', options).format(date));
// → "Donnerstag, 20. Dezember 2012"
// an application may want to use UTC and make that visible
options.timeZone = 'UTC';
options.timeZoneName = 'short';
console.log(new Intl.DateTimeFormat('en-US', options).format(date));
// → "Thursday, December 20, 2012, GMT"
// sometimes you want to be more precise
options = {
hour: 'numeric', minute: 'numeric', second: 'numeric',
timeZone: 'Australia/Sydney',
timeZoneName: 'short'
};
console.log(new Intl.DateTimeFormat('en-AU', options).format(date));
// → "2:00:00 pm AEDT"
// sometimes you want to be very precise
options.fractionalSecondDigits = 3; //number digits for fraction-of-seconds
console.log(new Intl.DateTimeFormat('en-AU', options).format(date));
// → "2:00:00.200 pm AEDT"
// sometimes even the US needs 24-hour time
options = {
year: 'numeric', month: 'numeric', day: 'numeric',
hour: 'numeric', minute: 'numeric', second: 'numeric',
hour12: false,
timeZone: 'America/Los_Angeles'
};
console.log(new Intl.DateTimeFormat('en-US', options).format(date));
// → "12/19/2012, 19:00:00"
// to specify options but use the browser's default locale, use 'default'
console.log(new Intl.DateTimeFormat('default', options).format(date));
// → "12/19/2012, 19:00:00"
// sometimes it's helpful to include the period of the day
options = {hour: "numeric", dayPeriod: "short"};
console.log(new Intl.DateTimeFormat('en-US', options).format(date));
// → 10 at night
The used calendar and numbering formats can also be set independently via options
arguments:
var options = {calendar: 'chinese', numberingSystem: 'arab'};
var dateFormat = new Intl.DateTimeFormat('default', options);
var usedOptions = dateFormat.resolvedOptions();
console.log(usedOptions.calendar);
// → "chinese"
console.log(usedOptions.numberingSystem);
// → "arab"
console.log(usedOptions.timeZone);
// → "America/New_York" (the users default timezone)
Specifications
Specification |
---|
ECMAScript Internationalization API Specification # datetimeformat-objects |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DateTimeFormat | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
DateTimeFormat() constructor | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support13.0.0 |
locales parameter | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support13.0.0 |
options parameter | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
options.dateStyle parameter | ChromeFull support76 | EdgeFull support79 | FirefoxFull support79 | Internet ExplorerNo supportNo | OperaFull support63 | SafariFull support14.1 | WebView AndroidFull support76 | Chrome AndroidFull support76 | Firefox for AndroidFull support79 | Opera AndroidFull support54 | Safari on iOSFull support14.5 | Samsung InternetFull support12.0 | DenoFull support1.8 | Node.jsFull support12.9.0 |
options.dayPeriod parameter | ChromeFull support92 | EdgeFull support92 | FirefoxFull support90 | Internet ExplorerNo supportNo | OperaFull support78 | SafariFull support14.1 | WebView AndroidFull support92 | Chrome AndroidFull support92 | Firefox for AndroidFull support90 | Opera AndroidNo supportNo | Safari on iOSFull support14.5 | Samsung InternetFull support16.0 | DenoFull support1.12 | Node.jsNo supportNo |
options.fractionalSecondDigits parameter | ChromeFull support84 | EdgeFull support84 | FirefoxFull support84 | Internet ExplorerNo supportNo | OperaFull support70 | SafariFull support14.1 | WebView AndroidFull support84 | Chrome AndroidFull support84 | Firefox for AndroidFull support84 | Opera AndroidFull support60 | Safari on iOSFull support14.5 | Samsung InternetFull support14.0 | DenoFull support1.8 | Node.jsFull support14.6.0 |
options.hourCycle parameter | ChromeFull support73 | EdgeFull support18 | FirefoxFull support58 | Internet ExplorerNo supportNo | OperaFull support60 | SafariFull support13 | WebView AndroidFull support73 | Chrome AndroidFull support73 | Firefox for AndroidFull support58 | Opera AndroidFull support52 | Safari on iOSFull support13 | Samsung InternetFull support11.0 | DenoFull support1.8 | Node.jsFull support12.0.0 |
options.timeStyle parameter | ChromeFull support76 | EdgeFull support79 | FirefoxFull support79 | Internet ExplorerNo supportNo | OperaFull support63 | SafariFull support14.1 | WebView AndroidFull support76 | Chrome AndroidFull support76 | Firefox for AndroidFull support79 | Opera AndroidFull support54 | Safari on iOSFull support14.5 | Samsung InternetFull support12.0 | DenoFull support1.8 | Node.jsFull support12.9.0 |
options.timeZone parameter | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerNo supportNo | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
IANA time zone names in options.timeZone option | ChromeFull support24 | EdgeFull support14 | FirefoxFull support52 | Internet ExplorerNo supportNo | OperaFull support15 | SafariFull support10 | WebView AndroidFull support37 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support4.0.0 |
options.timeZoneName parameter | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerNo supportNo | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
IANA time zone names in options.timeZoneName option | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support91 | Internet ExplorerNo supportNo | OperaNo supportNo | SafariFull support15.4 | WebView AndroidNo supportNo | Chrome AndroidNo supportNo | Firefox for AndroidFull support91 | Opera AndroidNo supportNo | Safari on iOSFull support15.4 | Samsung InternetNo supportNo | DenoNo supportNo | Node.jsNo supportNo |
format | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
formatRange | ChromeFull support76 | EdgeFull support79 | FirefoxFull support91 | Internet ExplorerNo supportNo | OperaFull support63 | SafariFull support14.1 | WebView AndroidFull support76 | Chrome AndroidFull support76 | Firefox for AndroidFull support91 | Opera AndroidFull support54 | Safari on iOSFull support14.5 | Samsung InternetFull support12.0 | DenoFull support1.8 | Node.jsFull support12.9.0 |
formatRangeToParts | ChromeFull support76 | EdgeFull support79 | FirefoxFull support91 | Internet ExplorerNo supportNo | OperaFull support63 | SafariFull support14.1 | WebView AndroidFull support76 | Chrome AndroidFull support76 | Firefox for AndroidFull support91 | Opera AndroidFull support54 | Safari on iOSFull support14.5 | Samsung InternetFull support12.0 | DenoFull support1.8 | Node.jsFull support12.9.0 |
formatToParts | ChromeFull support57 | EdgeFull support18 | FirefoxFull support51 | Internet ExplorerNo supportNo | OperaFull support44 | SafariFull support11 | WebView AndroidFull support57 | Chrome AndroidFull support57 | Firefox for AndroidFull support56 | Opera AndroidFull support43 | Safari on iOSFull support11 | Samsung InternetFull support7.0 | DenoFull support1.8 | Node.jsFull support8.0.0 |
resolvedOptions | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support0.12.0 |
computed timeZone | ChromeFull support35 | EdgeFull support14 | FirefoxFull support53 | Internet ExplorerNo supportNo | OperaFull support30 | SafariFull support10 | WebView AndroidFull support37 | Chrome AndroidFull support35 | Firefox for AndroidFull support56 | Opera AndroidFull support22 | Safari on iOSFull support10 | Samsung InternetFull support3.0 | DenoFull support1.8 | Node.jsFull support8.10.0 |
supportedLocalesOf | ChromeFull support24 | EdgeFull support12 | FirefoxFull support29 | Internet ExplorerFull support11 | OperaFull support15 | SafariFull support10 | WebView AndroidFull support4.4 | Chrome AndroidFull support25 | Firefox for AndroidFull support56 | Opera AndroidFull support14 | Safari on iOSFull support10 | Samsung InternetFull support1.5 | DenoFull support1.8 | Node.jsFull support13.0.0 |
Legend
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- See implementation notes.