Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/formatjs/date-time-format-timezone
Surgically polyfills timezone support in Intl.DateTimeFormat API
https://github.com/formatjs/date-time-format-timezone
cldr datetimeformat ecma-402 iana icu intl polyfill
Last synced: 2 months ago
JSON representation
Surgically polyfills timezone support in Intl.DateTimeFormat API
- Host: GitHub
- URL: https://github.com/formatjs/date-time-format-timezone
- Owner: formatjs
- License: other
- Archived: true
- Created: 2017-01-13T16:29:07.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-26T23:20:09.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T00:59:14.296Z (9 months ago)
- Topics: cldr, datetimeformat, ecma-402, iana, icu, intl, polyfill
- Language: JavaScript
- Homepage:
- Size: 2.22 MB
- Stars: 108
- Watchers: 9
- Forks: 20
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-pure-js - date-time-format-timezone
README
# Intl.DateTimeFormat timezone polyfill
Surgically polyfills timezone support in `Intl.DateTimeFormat` API
[](https://travis-ci.org/formatjs/date-time-format-timezone) [](https://www.npmjs.com/package/date-time-format-timezone)
Some [browsers do not support arbitrary time zone ](http://kangax.github.io/compat-table/esintl/) in Intl.DateTimeFormat API (becuase its optional as per [ECMA-402 standard](https://www.ecma-international.org/ecma-402/1.0/#sec-6.4)). This polyfill is only to bring this support. Polyfill contains historical timezone data, CLDR data & tiny code to polyfill this support.
## How to use?
1. Install via nodejs:
```
npm i date-time-format-timezone
```
And then import in your code:
```
require('date-time-format-timezone'); // polyfill is ready
```
2. In the browser
include everything:
```
```
or include individual files:
```
<script src="https://unpkg.com/date-time-format-timezone@latest/build/browserified/date-time-format-timezone-no-data-min.js">
<script src="https://unpkg.com/date-time-format-timezone@latest/build/browserified/data/locales/locale-en-US-POSIX.js">
<script src="https://unpkg.com/date-time-format-timezone@latest/build/browserified/data/metazone.js">
<script src="https://unpkg.com/date-time-format-timezone@latest/build/browserified/data/timezones/tzdata-america-los_angeles.js">
```
This polyfill can add this support.
```javascript
new Intl.DateTimeFormat('hi', {
timeZone: 'Asia/Calcutta',
timeZoneName:'long',
year: 'numeric',
month: 'numeric',
day: 'numeric',
hour: 'numeric',
minute: 'numeric',
}).format(new Date());
"११/१/२०१७, पू १:२६ भारतीय मानक समय"
new Intl.DateTimeFormat('en', {
timeZone: 'America/Los_Angeles',
timeZoneName:'long',
year: 'numeric',
month: 'numeric',
day: 'numeric',
hour: 'numeric',
minute: 'numeric',
}).format(new Date());
"1/10/2017, 12:00 PM Pacific Standard Time"
```
## Support
| API |Support|
|--------------------------------- |------ |
| Intl.DateTimeFormat | ✅ |
| Date.toLocaleString | ✅ |
| Date.toLocaleTimeString | ✅ |
| Date.toLocaleTimeString | ✅ |
## Generate latest data from [www.iana.org](http://www.iana.org/time-zones).
```
git checkout https://github.com/yahoo/date-time-format-timezone.git
npm install
grunt download
grunt
npm publish
```
## Browserified file size
| | Minified | gzipped |
|----------------------------|----------|---------|
| complete | 2.64MB | 322KB |
| top zones<sup>1</sup> only no locale | 369.32KB | 71KB |
| all zones no locale | 303.19KB | 75KB |
| top zones<sup>1</sup> top locale<sup>2</sup> | 641.86KB | 148KB |
*1. top zones are custom listed timezones [here](https://github.com/yahoo/date-time-format-timezone/blob/master/tasks/gen-package.js#L51).
*2. top locales are custom listed locales [here](https://github.com/yahoo/date-time-format-timezone/blob/master/tasks/gen-package.js#L13).
## References
1. http://www.unicode.org/reports/tr35/tr35-dates.html#Using_Time_Zone_Names
1. http://icu-project.org/apiref/icu4j/com/ibm/icu/text/TimeZoneNames.html