Skip to content
@northguild/gmt

zoned/format

  • formatCalendarZoned: Format a zoned date-time as a relative day label plus time-of-day, e.g. “Tomorrow at 2:30 PM” — the zoned counterpart of formatCalendar.
  • formatRelativeZoned: Format the relative time between a zoned date-time and a reference instant.
  • formatRfc2822: Format a zoned ISO 8601 datetime string as an RFC 5322 (RFC 2822) date-time — the fixed grammar email Date: headers require.
  • formatRfc3339: Format a zoned ISO 8601 datetime string as strict RFC 3339 — the ISO 8601 profile RFC 3339 §5.6 defines, permitting only an explicit numeric offset or Z, never a bracketed IANA zone name.
  • formatTimeZoneName: Return the localized display name for an IANA timeZone.
  • formatZonedDateTime: Format a zoned ISO 8601 datetime string using the Intl.DateTimeFormat implementation.
  • formatZonedRange: Format a zoned datetime range using the Temporal Intl.DateTimeFormat formatRange API.
  • formatZonedToParts: Return the locale-formatted parts of a ZonedDateTime.

Types

Section titled “Types”
  • FormatCalendarZonedOptions: Options for formatCalendarZoned: the moment the day label is measured from and the length of the time-of-day half.
  • FormatRelativeZonedOptions: Options for formatRelativeZoned: how the phrase is worded, the unit it counts in, how the count rounds and the moment the distance is measured from.
  • FormatTimeZoneNameOptions: Options for formatTimeZoneName: the form the zone name is written in.
  • TimeZoneNameStyle: Name style for formatTimeZoneName, mirroring Intl.DateTimeFormatOptions’s timeZoneName values.