Điểm qua date-fns/tz: 267 sao trên GitHub, viết chủ yếu bằng TypeScript. date-fns timezone utils
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
🚨🚨🚨 @date-fns/tz has moved to the date-fns monorepo 🚨🚨🚨
@date-fns/tz
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 also be 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.
Installation
npm install @date-fns/tz --save
Usage
TZDate 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)'
Accepted time zone formats
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");
Difference between TZDate and TZDateMini
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.
React Native / Hermes JS Engine
Starting with v1.3.0, @date-fns/tz supports Format.JS polyfills that are required for Hermes JS Engine powering React Native runtime to work correctly.
To use it, you need to import the following polyfills in your entry point:
The JavaScriptCore engine is also supported and tested but does not require any polyfills.
API
TZDate
tz
tzOffset
tzScan
TZDate
All the TZDate docs are also true for TZDateMini.
Constructor
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.
TZDate.tz
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 Date
Just like the constructor, the function accepts all parameters variants:
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;
// undefined
withTimeZone
The 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)'
[Symbol.for("constructDateFrom")]
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";
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"),
});
//=> true
tzOffset
The 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");
//=> -240
Unlike 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.
tzScan
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:
Có — date-fns/tz phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/date-fns/tz.
date-fns/tz có tag gì không?
Bản đồng bộ chưa ghi nhận topic GitHub nào cho date-fns/tz. GitHub topics hiển thị ở thanh bên phải trang repo — đó là nơi đáng kiểm tra nhất.
date-fns/tz có website riêng không?
TopGit chưa ghi nhận URL trang chủ cho date-fns/tz. Phần README ở tab phía trên thường có link demo, hoặc xem mô tả GitHub của repo.
date-fns/tz còn đang phát triển không?
Commit gần nhất trên date-fns/tz là 6 tháng trước (theo timestamp GitHub). Repo có 23 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
date-fns/tz dùng license gì?
date-fns/tz phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
Đọc thêm về date-fns/tz ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/date-fns/tz là nguồn chính thức.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về tz?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về tz.