FormatCalendarUtcOptions

The FormatCalendarUtcOptions type.

import type { FormatCalendarUtcOptions } from "@northguild/gmt/utc/format";

Members

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

Definition

interface FormatCalendarUtcOptions {
  reference?: string;
  /**
   * IANA timezone used for both the calendar-day comparison and the
   * rendered clock time. Resolved via `normalizeTimeZone` — `"local"` for
   * the system zone, an invalid/omitted value falls back to `"UTC"`.
   */
  timeZone?: string;
  /** `Intl.DateTimeFormatOptions` `timeStyle` for the time-of-day half. */
  timeStyle?: "short" | "medium" | "full";
}

Used by

• formatCalendarUtc

Source

utc/format/formatCalendarUtc.ts