palantir/blueprint

Support retrieving timezone metadata via properties other than IANA code

Open

#5794 opened on Dec 9, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
P2Package: datetimeType: feature requesthelp wanted

Description

Environment

  • Package version(s): datetime2 v0.9.6

Feature request

@blueprintjs/datetime2 supports getTimezoneMetadata() where you pass in a timezone IANA code. But sometimes I'd like to query for the metadata with other information, like the UTC offset.

When querying by only the offset, we know that one offset may correspond to multiple timezones. In these cases we may only care about the minimal set of timezones (see https://github.com/palantir/blueprint/issues/5793).

We could probably support this in the existing API:

function getTimezoneMetadata(offsetOrIanaCode: string, date?: Date): TimezoneMetadata | undefined;

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with TypeScriptunderstanding of IANA timezone database
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the existing `getTimezoneMetadata` function in `@blueprintjs/datetime2`. Review the linked issue #5793 for context on handling multiple timezones per offset. The implementation should extend the function's parameter to accept either an IANA code or a UTC offset string, returning metadata for all matching timezones. Consider using the `Intl.DateTimeFormat` or `luxon` library for timezone resolution.