FormatCalendarOptions

The FormatCalendarOptions type.

import type { FormatCalendarOptions } from "@northguild/gmt/plain/format";

Members

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

Definition

interface FormatCalendarOptions {
  reference?: string;
  /**
   * `Intl.DateTimeFormatOptions` `timeStyle` for the time-of-day half.
   * "full" is deliberately not offered here: it appends a `timeZoneName`
   * (e.g. "Coordinated Universal Time"), and plain values have no real
   * timezone — the UTC anchor below is an implementation detail, not a
   * fact about `value`, so surfacing it as a zone name would be a lie.
   */
  timeStyle?: "short" | "medium";
}

Used by

• formatCalendar

Source

plain/format/formatCalendar.ts