tz.js/README.md

234 lines
5.7 KiB
Markdown
Raw Normal View History

2021-05-28 06:17:38 +00:00
# [xtz.js](https://github.com/therootcompany/tz.js)
2019-06-12 08:39:07 +00:00
2021-05-28 06:57:42 +00:00
A fast, lightweight, zero-dependency library to translate between Time Zones and UTC with native `Intl.DateTimeFormat`
in ~100 LoC. For Node.js & Browsers.
2021-05-28 08:04:29 +00:00
[![](./xtz-preview.png)](https://therootcompany.github.io/tz.js/)
2021-05-28 08:03:41 +00:00
2021-05-30 10:31:52 +00:00
XTZ is a poor man's `Temporal` polyfill, but just for timezones. \
2021-05-28 08:03:41 +00:00
Demo: <https://therootcompany.github.io/tz.js/>
> What UTC time will it be when it's 3:15am in New York?
2021-05-30 10:31:52 +00:00
```js
TZ.toISOString("2021-11-07 03:15:59.000", "UTC", "America/New_York");
TZ.toISOString("2021-11-07 03:15:59.000", "America/New_York", "UTC");
TZ.toISOString("2021-11-07 03:15:59.000", "America/New_York");
TZ.toISOString("2021-11-07T03:15:59.000Z", "America/New_York");
TZ.toISOString("2021-11-07 03:15:59.000", "America/New_York", "America/Denver");
```
```js
// Relative New York time to Absolute UTC Time
2021-05-30 10:31:52 +00:00
TZ.toISOString("2021-11-07 03:15:59.000", "America/New_York");
// "2021-11-07T03:15:59.000-0500"
```
```js
var tzDate = TZ.toUTC("2021-11-07 03:15:59.000", "America/New_York");
// {
2021-05-28 14:37:35 +00:00
// year: 2021, month: 10, day: 7,
// hour: 3, minute: 15, second: 59, millisecond: 0,
// offset: -300, timeZoneName: "Eastern Standard Time"
// }
tzDate.toISOString();
// "2021-11-07T03:15:59.000-0500"
2021-05-28 06:33:21 +00:00
// (same as "2021-11-07T08:15:59.000Z")
```
> What time will it be in New York when it's 7:15am UTC?
```js
// Absolute UTC time to Relative New York time
2021-05-30 10:31:52 +00:00
TZ.toISOString("2021-03-14 07:15:59.000", "UTC", "America/New_York");
2021-05-28 06:33:21 +00:00
// "2021-03-14T03:15:59.000-0400"
```
```js
var utcDate = TZ.toTimeZone("2021-03-14T07:15:59.000Z", "America/New_York");
// {
2021-05-28 14:37:35 +00:00
// year: 2021, month: 2, day: 14,
// hour: 3, minute: 15, second: 59, millisecond: 0,
// offset: -240, timeZoneName: "Eastern Daylight Time"
// }
utcDate.toISOString();
// "2021-03-14T03:15:59.000-0400"
2021-05-28 06:33:21 +00:00
// (same as "2021-11-07T07:15:59.000Z")
```
# Features
2021-05-28 06:57:42 +00:00
- [x] Translate a UTC time to a Time Zone
- [x] Translate a Zoned time to UTC
- [x] Handles **Daylight Savings**, Weird Time Zones, etc...
- [x] Well-tested `npm run test`
- [x] Lightweight (No deps)
- 5kb Source + Comments
- 2.5kb Minified
- <1kb `gzip`d
2021-05-28 06:42:21 +00:00
Compatible with Browsers, and Node.js.
2021-05-28 06:42:21 +00:00
## Browsers
2021-05-28 06:42:21 +00:00
```html
<script src="https://unpkg.com/xtz@latest/xtz.min.js"></script>
```
```js
2021-05-28 06:42:21 +00:00
var TZ = window.XTZ;
```
2021-05-28 06:42:21 +00:00
## Node.js & Webpack
2021-05-28 06:42:21 +00:00
```bash
npm install --save xtz
```
```js
2021-05-28 06:42:21 +00:00
var TZ = require("xtz");
```
2021-05-28 08:03:41 +00:00
## Demo
See <https://therootcompany.github.io/tz.js/>.
# API
2021-05-30 10:31:52 +00:00
- `toTimeZone(utcDate, outputZone)`
- `toTimeZoneISOString(isoString, outputZone)`
- `toUTC(dtString, inputZone)`
- `toUTCISOString(dtString, inputZone)`
2021-05-30 10:31:52 +00:00
## `toTimeZone(utcDate, outputZone)`
> Convert UTC into a Target Time Zone
2021-05-28 14:28:01 +00:00
Use ISO timestamps representing the absolute UTC time (with or without offset):
```txt
"2021-11-07T08:15:59.000Z"
```
Convert directly to an ISO String:
```js
TZ.toTimeZoneISOString("2021-11-07T08:15:59.000Z", "America/New_York");
// "2021-11-07T03:15:59.000-0500"
```
Or use our bespoke (custom) date object:
```js
var tzDate = TZ.toTimeZone("2021-11-07T08:15:59.000Z", "America/New_York");
```
You can also use a date object with an absolute UTC time:
```js
var tzDate = TZ.toTimeZone(
2021-05-28 06:57:42 +00:00
new Date("2021-11-07T08:15:59.000Z"),
"America/New_York"
);
```
```js
console.log(tzDate.toISOString());
// "2021-11-07T03:15:59.000-0500"
```
Our ISO Strings + Offsets work with JavaScript's native Date object!!
```js
new Date("2021-11-07T03:15:59.000-0500").toISOString());
// "2021-11-07T08:15:59.000Z"
```
2021-05-30 10:31:52 +00:00
## `toUTC(dtString, outputZone)`
> Convert a Target Time Zone into UTC
Use ISO-like timestamps representing the _local_ time in the target time zone:
```txt
2021-05-28 08:14:13 +00:00
"2021-11-0 03:15:59.000"
```
Convert directly to an offset ISO String:
```js
TZ.toUTCISOString("2021-11-07 03:15:59.000", "America/New_York");
// "2021-11-07T03:15:59.000-0500"
```
Or our bespoke date object:
```js
var utcDate = TZ.toUTC("2021-11-07 03:15:59.000", "America/New_York");
```
2021-05-28 06:57:42 +00:00
You can also use a date object as the source time, but the date's UTC time will be treated as **_relative to time
zone_** rather than absolute (this is a workaround for JavaScript's lack of bi-directional timezone support).
```js
var utcDate = TZ.toUTC(
2021-05-28 06:57:42 +00:00
new Date("2021-11-07T03:15:59.000Z"),
"America/New_York"
);
```
```js
utcDate.toISOString();
// "2021-11-07T03:15:59.000-0500"
```
# Daylight Savings / Edge Cases
> In 2021 Daylight Savings (in the US)
>
2021-05-28 14:08:53 +00:00
> - begins at 2am on March 14th (skips to 3am)
> - ends at 2am on November 7th (resets to 1am)
>
> See <https://www.timeanddate.com/time/change/usa>.
Q: What happens in March when 2am is skipped?
2021-05-28 06:57:42 +00:00
- A: Although 2am is not a valid time, rather than throwing an error this library will resolve to 1am instead, which
is an hour early in real ("tick-tock" or "monotonic") time.
```js
var utcDate = TZ.toUTC("2021-03-14 02:15:59.000", "America/New_York");
utcDate.toISOString();
// "2021-03-14T02:15:59.000-0400"
// (same as "2021-03-14T01:15:59.000-0500")
```
2021-05-28 14:08:53 +00:00
Q: What happens in November when 1am happens twice?
2021-05-28 14:08:53 +00:00
- A: Although both 1ams are distinguishable with ISO offset times, only the first can be resolved from a local time
2021-05-28 06:57:42 +00:00
with this library.
```js
var utcDate = TZ.toUTC("2021-11-07 01:15:59.000", "America/New_York");
utcDate.toISOString();
// "2021-11-07T01:15:59.000-0400", same as "2021-11-07T05:15:59.000Z"
2021-05-28 14:08:53 +00:00
// (an hour before the 2nd 1am at "2021-11-07T01:15:59.000-0500")
2021-05-28 06:57:42 +00:00
```
# List of Time Zones
See the [Full List of Time Zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) on Wikipedia.
Common Zones for Testing:
```txt
America/New_York -0500
America/Denver -0700
America/Phoenix -0700 (No DST)
America/Los_Angeles -0800
2021-05-28 15:04:56 +00:00
UTC Z
Australia/Adelaide +0930 (30-min, has DST)
Asia/Kathmandu +0545 (No DST, 45-min)
Asia/Kolkata +0530 (No DST, 30-min)
```