Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
date-fns-tz
Advanced tools
The date-fns-tz package is a complementary library to date-fns that provides comprehensive timezone support for date manipulation. It allows users to parse and format dates in any timezone and provides utilities for working with zoned dates.
Timezone-aware date parsing
This feature allows you to convert a local time string to a UTC date, taking into account the specified timezone.
import { zonedTimeToUtc } from 'date-fns-tz';
const date = zonedTimeToUtc('2023-04-01T12:00:00', 'America/New_York');
Timezone-aware date formatting
This feature allows you to format a UTC date to a string that represents the date and time in a specified timezone.
import { format } from 'date-fns';
import { utcToZonedTime, format } from 'date-fns-tz';
const date = new Date('2023-04-01T16:00:00Z');
const newYorkDate = utcToZonedTime(date, 'America/New_York');
const formattedDate = format(newYorkDate, 'yyyy-MM-dd HH:mm:ssXXX', { timeZone: 'America/New_York' });
Timezone conversion
This feature allows you to convert dates between UTC and a specified timezone.
import { utcToZonedTime, zonedTimeToUtc } from 'date-fns-tz';
const utcDate = new Date('2023-04-01T16:00:00Z');
const zonedDate = utcToZonedTime(utcDate, 'Europe/Berlin');
const backToUtc = zonedTimeToUtc(zonedDate, 'Europe/Berlin');
Moment-timezone is a plugin for the Moment.js library. It provides similar functionality for parsing, formatting, and manipulating dates in different timezones. It is more established but also larger in size compared to date-fns-tz, which is modular and tree-shakable.
Luxon is a modern library for working with dates and times in JavaScript. It includes timezone support out of the box and offers a fluent API. Luxon is often considered a lighter and more modern alternative to Moment.js, and it provides similar timezone handling capabilities as date-fns-tz.
Day.js is a minimalist JavaScript library that parses, validates, manipulates, and displays dates and times for modern browsers with a largely Moment.js-compatible API. The timezone plugin for Day.js adds functionality similar to date-fns-tz, allowing for timezone-aware date operations.
Time zone support for date-fns v2.0.0 using the Intl API. By using the browser API no time zone data needs to be included in code bundles. Modern browsers all support the necessary features, and for those that don't a polyfill can be used.
If you do not wish to use a polyfill the time zone option can still be used, but only with time zone offsets such as '-0200' or '+04:00' and not IANA time zone names.
zonedTimeToUtc
- Given a date and any time zone, returns a Date
with the equivalent UTC timeutcToZonedTime
- Get a date/time representing local time in a given time zone from the UTC dategetTimezoneOffset
- Gets the offset in milliseconds between the time zone and UTC timeWorking with UTC or ISO date strings is easy, and so is working with JS dates when all times are displayed in a user's local time in the browser. The difficulty comes when working with another time zone's local time, other than the current system's, like on a Node server or when showing the time of an event in a specific time zone, like an event in LA at 8pm PST regardless of where a user resides.
In this case there are two relevant pieces of information:
America/New_York
).Libraries like Moment and Luxon, which provide their own date time classes, manage these timestamp and time
zone values internally. Since date-fns
always returns a plain JS Date, which implicitly has the current
system's time zone, helper functions are provided for handling common time zone related use cases.
To discuss the usage of the time zone helpers let's assume we're writing a system where administrators set up events which will start at a specific time in the venue's local time, and this local time should be shown when accessing the site from anywhere in the world.
zonedTimeToUtc
Given a date and any time zone, returns a Date
with the equivalent UTC time
zonedTimeToUtc(date: Date|Number|String, timeZone: String): Date
Say a user is asked to input the date/time and time zone of an event. A date/time picker will typically return a Date instance with the chosen date, in the user's local time zone, and a select input might provide the actual IANA time zone name.
In order to work with this info effectively it is necessary to find the equivalent UTC time:
import { zonedTimeToUtc } from 'date-fns-tz'
const date = getDatePickerValue() // e.g. 2014-06-25 10:00:00 (picked in any time zone)
const timeZone = getTimeZoneValue() // e.g. America/Los_Angeles
const utcDate = zonedTimeToUtc(date, timeZone) // In June 10am in Los Angeles is 5pm UTC
postToServer(utcDate.toISOString(), timeZone) // post 2014-06-25T17:00:00.000Z, America/Los_Angeles
utcToZonedTime
Get a date/time in the local time of any time zone from UTC time
utcToZonedTime(date: Date|Number|String, timeZone: String): Date
Say the server provided a UTC date/time and a time zone which should be used as initial values for the above form. The date/time picker will take a Date input which will be in the user's local time zone, but the date value must be that of the target time zone.
import { utcToZonedTime } from 'date-fns-tz'
const { isoDate, timeZone } = fetchInitialValues() // 2014-06-25T10:00:00.000Z, America/New_York
const date = utcToZonedTime(isoDate, timeZone) // In June 10am UTC is 6am in New York (-04:00)
renderDatePicker(date) // 2014-06-25 06:00:00 (in the system time zone)
renderTimeZoneSelect(timeZone) // America/New_York
getTimezoneOffset
Gets the offset in milliseconds between the time zone and UTC time
getTimezoneOffset(timeZone: String, date: Date|Number): number
Returns the time zone offset from UTC time in milliseconds for IANA time zones as well as other time zone offset string formats.
For time zones where daylight savings time is applicable a Date
should be passed on
the second parameter to ensure the offset correctly accounts for DST at that time of
year. When omitted, the current date is used.
import { getTimezoneOffset } from 'date-fns-tz'
const result = getTimezoneOffset('-07:00')
//=> -18000000 (-7 * 60 * 60 * 1000)
const result = getTimezoneOffset('Africa/Johannesburg')
//=> 7200000 (2 * 60 * 60 * 1000)
const result = getTimezoneOffset('America/New_York', new Date(2016, 0, 1))
//=> -18000000 (-5 * 60 * 60 * 1000)
const result = getTimezoneOffset('America/New_York', new Date(2016, 6, 1))
//=> -14400000 (-4 * 60 * 60 * 1000)
format
The format
function exported from this library extends date-fns/format
with full time zone support for:
z..zzz
Unicode tokens: short specific non-location formatzzzz
Unicode token: long specific non-location formatWhen using those tokens with date-fns/format
it falls back to GMT timezones, and always uses the local
system timezone. For example zzz
in New York would return GMT-4
instead of the desired EST
, whereas
this extended format
function will return the latter.
To format a date to a string showing time for a specific time zone, which can be different from the system
time zone, the format
function can be combined with utcToZonedTime
as shown in the example below. To
clarify, the format
function will never change the underlying date, it must be changed to a zoned time
before passing it to format
.
Since a zoned time Date
instance cannot convey the time zone information to the format
function it is
necessary to pass the same timeZone
value as an option on the third argument of format
. When using this
option the z..zzzz
, x..xxxxx
, X..XXXXX
and O..OOO
tokens will all print the provided time zone rather
than the system time zone.
import { format, utcToZonedTime } from 'date-fns-tz'
const date = new Date('2014-10-25T10:46:20Z')
const nyTimeZone = 'America/New_York'
const parisTimeZone = 'Europe/Paris'
const nyDate = utcToZonedTime(date, nyTimeZone)
const parisDate = utcToZonedTime(date, parisTimeZone)
format(nyDate, 'yyyy-MM-dd HH:mm:ssXXX', { timeZone: 'America/New_York' }) // 2014-10-25 06:46:20-04:00
format(nyDate, 'yyyy-MM-dd HH:mm:ss zzz', { timeZone: 'America/New_York' }) // 2014-10-25 06:46:20 EST
format(parisDate, 'yyyy-MM-dd HH:mm:ss zzz', { timeZone: 'Europe/Paris' }) // 2014-10-25 10:46:20 GMT+2
// The time zone name is generated by the Intl API which works best when a locale is also provided
import enGB from 'date-fns/locale/en-GB'
format(parisDate, 'yyyy-MM-dd HH:mm:ss zzz', {
timeZone: 'Europe/Paris',
locale: enGB,
})
// 2014-10-25 10:46:20 CEST
format(parisDate, 'yyyy-MM-dd HH:mm:ss zzzz', {
timeZone: 'Europe/Paris',
locale: enGB,
})
// 2014-10-25 10:46:20 Central European Summer Time
toDate
The toDate
function can be used to create a zoned Date from a string containing an offset or IANA
time zone, or by providing the timeZone
option.
import { toDate, format } from 'date-fns-tz'
// Offsets in the date string work as usual and take precedence
const parisDate = toDate('2014-10-25T13:46:20+02:00')
format(parisDate, 'yyyy-MM-dd HH:mm:ssZ', { timeZone: 'Europe/Paris' }) // 2014-10-25 13:46:20+02:00
// Since toDate simply clones a Date instance timeZone option is effectively ignored in this case
const date = new Date('2014-10-25T13:46:20Z')
const clonedDate = toDate(date, { timeZone: 'Europe/Paris' })
assert(date.valueOf() === clonedDate.valueOf())
// When there is no offset in the date string the timeZone property is used
const bangkokDate = toDate('2014-10-25T13:46:20', { timeZone: 'Asia/Bangkok' })
format(bangkokDate, 'yyyy-MM-dd HH:mm:ssZ', { timeZone: 'Asia/Bangkok' }) // 2014-10-25 13:46:20+07:00
const nyDate = toDate('2014-10-25T13:46:20 America/New_York')
format(nyDate, 'yyyy-MM-dd HH:mm:ssZ', { timeZone: 'America/New_York' }) // 2014-10-25 13:46:20-04:00
Note: Since the Intl API does not provide a way to parse long or short time zone names the parse
function cannot be supported using this approach.
Node.js supports the Intl
API. From v13 Node.js ships with full ICU data included in the binary, however
the current LTS version 12.14 is still built with the small-icu
flag and only contains ICU data for the
en-US
locale. To use this library with Node.js 12 and any locale other than en-US
it should be run
with
ICU data provided at runtime.
The idea of using the Intl API for time zone support was inspired by the Luxon library.
The initial port of the idea into date-fns was done by @benmccan in date-fns/#676.
MIT © Marnus Weststrate
v1.1.7 (17 December 2021)
format
handling of quoted text next to a time zone token (#136)FAQs
Time zone support for date-fns v3 with the Intl API
The npm package date-fns-tz receives a total of 2,805,360 weekly downloads. As such, date-fns-tz popularity was classified as popular.
We found that date-fns-tz demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.