FormatCalendarZonedOptions

The FormatCalendarZonedOptions type.

import type { FormatCalendarZonedOptions } from "@northguild/gmt/zoned/format";

Members

Member	Type	Description
reference?	string | number	—
timeStyle?	"short" | "medium" | "full"	—

Definition

interface FormatCalendarZonedOptions {
  /**
   * Anchor point for the relative diff.
   *
   * - ZonedDateTime ISO string: converted into `value`'s own zone before
   *   comparing calendar days. Unlike `formatRelativeZoned`'s `reference`
   *   (which keeps a ZonedDateTime reference in its own zone for
   *   elapsed-time diffing), a calendar *label* is meaningless without
   *   picking one zone's wall clock — `value`'s zone is the natural choice,
   *   since that is whose "today" is being described.
   * - UTC ISO string or numeric epoch (ms): placed into `value`'s timezone.
   * - Omitted: "now" in `value`'s own timezone.
   */
  reference?: string | number;
  /** `Intl.DateTimeFormatOptions` `timeStyle` for the time-of-day half. */
  timeStyle?: "short" | "medium" | "full";
}

Used by

• formatCalendarZoned

Source

zoned/format/formatCalendarZoned.ts