The package provides Date extensions TZDate and TZDateMini that perform all calculations in the given time zone rather than the system time zone.
Using it makes date-fns operate in given time zone but can be also used without it.
Like everything else in the date-fns ecosystem, the library is build-size aware. The smallest component, TZDateMini, is only 916 B.
Need only UTC? See @date-fns/utc that provides lighter solution.
npm install @date-fns/tz --saveTZDate and TZDateMini have API similar to Date, but perform all calculations in the given time zone, which might be essential when operating across different time zones, calculating dates for users in different regions, or rendering chart or calendar component:
import { TZDate } from "@date-fns/tz";
import { addHours } from "date-fns";
// Given that the system time zone is America/Los_Angeles
// where DST happens at Sunday, 13 March 2022, 02:00:00
// Using system time zone will produce 03:00 instead of 02:00 because of DST:
const date = new Date(2022, 2, 13);
addHours(date, 2).toString();
//=> 'Sun Mar 13 2022 03:00:00 GMT-0700 (Pacific Daylight Time)'
// Using Asia/Singapore will provide expected 02:00:
const tzDate = new TZDate(2022, 2, 13, "Asia/Singapore");
addHours(tzDate, 2).toString();
//=> 'Sun Mar 13 2022 02:00:00 GMT 0800 (Singapore Standard Time)'You can pass IANA time zone name ("Asia/Singapore", "America/New_York", etc.) or UTC offset (" 01:00", "-2359", or " 23"):
new TZDate(2022, 2, 13, "Asia/Singapore");
new TZDate(2022, 2, 13, " 08:00");
new TZDate(2022, 2, 13, "-2359");The main difference between TZDate and TZDateMini is the build footprint. The TZDateMini is 916 B, and the TZDate is 1.2 kB. While the difference is slight it might be essential in some environments and use cases.
Unlike TZDateMini which implements only getters, setters, and getTimezoneOffset, TZDate also provides formatter functions, mirroring all original Date functionality:
import { TZDateMini, TZDate } from "@date-fns/tz";
// TZDateMini will format date-time in the system time zone:
new TZDateMini(2022, 2, 13).toString();
//=> 'Sat Mar 12 2022 16:00:00 GMT-0800 (Pacific Standard Time)'
// TZDate will format date-time in the Singapore time zone, like expected:
new TZDate(2022, 2, 13).toString();
//=> 'Sun Mar 13 2022 00:00:00 GMT 0800 (Singapore Standard Time)'Even though TZDate has a complete API, developers rarely use the formatter functions outside of debugging, so we recommend you pick the more lightweight TZDateMini for internal use. However, in environments you don't control, i.e., when you expose the date from a library, using TZDate will be a safer choice.
All the TZDate docs are also true for TZDateMini.
When creating TZDate, you can pass the time zone as the last argument:
new TZDate(2022, 2, "Asia/Singapore");
new TZDate(timestamp, "Asia/Singapore");
new TZDate("2024-09-12T00:00:00Z", "Asia/Singapore");The constructor mirrors the original Date parameters except for the last time zone parameter.
The static tz function allows to construct TZDate instance with just a time zone:
// Create now in Singapore time zone:
TZDate.tz("Asia/Singapore");
// ❌ This will not work, as TZDate expects a date string:
new TZDate("Asia/Singapore");
//=> Invalid DateJust like the constructor, the function accepts all parameters variants:
TZDate.tz("Asia/Singapore", 2022, 2);
TZDate.tz("Asia/Singapore", timestamp);
TZDate.tz("Asia/Singapore", "2024-09-12T00:00:00Z");The readonly timeZone property returns the time zone name assigned to the instance:
new TZDate(2022, 2, 13, "Asia/Singapore").timeZone;
// "Asia/Singapore"The property might be undefined when created without a time zone:
new TZDate().timeZone;
// undefinedThe withTimeZone method allows to create a new TZDate instance with a different time zone:
const sg = new TZDate(2022, 2, 13, "Asia/Singapore");
const ny = sg.withTimeZone("America/New_York");
sg.toString();
//=> 'Sun Mar 13 2022 00:00:00 GMT 0800 (Singapore Standard Time)'
ny.toString();
//=> 'Sat Mar 12 2022 11:00:00 GMT-0500 (Eastern Standard Time)'The TZDate instance also exposes a method to construct a Date instance in the same time zone:
const sg = TZDate.tz("Asia/Singapore");
// Given that the system time zone is America/Los_Angeles
const date = sg[Symbol.for("constructDateFrom")](new Date(2024, 0, 1));
date.toString();
//=> 'Mon Jan 01 2024 16:00:00 GMT 0800 (Singapore Standard Time)'It's created for date-fns but can be used in any context. You can access it via Symbol.for("constructDateFrom") or import it from the package:
import { constructFromSymbol } from "@date-fns/tz";The tz function allows to specify the context for the [date-fns] functions (starting from date-fns@4):
import { isSameDay } from "date-fns";
import { tz } from "@date-fns/tz";
isSameDay("2024-09-09T23:00:00-04:00", "2024-09-10T10:00:00 08:00", {
in: tz("Europe/Prague"),
});
//=> trueThe tzOffset function allows to get the time zone UTC offset in minutes from the given time zone and a date:
import { tzOffset } from "@date-fns/tz";
const date = new Date("2020-01-15T00:00:00Z");
tzOffset("Asia/Singapore", date);
//=> 480
tzOffset("America/New_York", date);
//=> -300
// Summer time:
tzOffset("America/New_York", "2020-01-15T00:00:00Z");
//=> -240Unlike Date.prototype.getTimezoneOffset, this function returns the value mirrored to the sign of the offset in the time zone. For Asia/Singapore (UTC 8), tzOffset returns 480, while getTimezoneOffset returns -480.
The function scans the time zone for changes in the given interval. It returns an array of objects with the date of the change, the offset change, and the new offset:
import { tzScan } from "@date-fns/tz";
tzScan("America/New_York", {
start: new Date("2020-01-01T00:00:00Z"),
end: new Date("2024-01-01T00:00:00Z"),
});
//=> [
//=> { date: 2020-03-08T07:00:00.000Z, change: 60, offset: -240 },
//=> { date: 2020-11-01T06:00:00.000Z, change: -60, offset: -300 },
//=> { date: 2021-03-14T07:00:00.000Z, change: 60, offset: -240 },
//=> { date: 2021-11-07T06:00:00.000Z, change: -60, offset: -300 },
//=> { date: 2022-03-13T07:00:00.000Z, change: 60, offset: -240 },
//=> { date: 2022-11-06T06:00:00.000Z, change: -60, offset: -300 },
//=> { date: 2023-03-12T07:00:00.000Z, change: 60, offset: -240 },
//=> { date: 2023-11-05T06:00:00.000Z, change: -60, offset: -300 }
//=> ]See the changelog.
