API reference / @localizer/format-datetime / DateTimeFormatOptions

Type Alias: DateTimeFormatOptions

DateTimeFormatOptions = object

Defined in: options.ts:24

Options for customizing date and time formatting.

Defines configuration options for the Intl.DateTimeFormat API.

Properties

Property	Modifier	Type	Description
calendar?	public	string	Calendar system for formatting.
dateStyle?	public	"full" | "long" | "medium" | "short"	Style for formatting date and time. Defaults to locale-based style if unspecified.
day?	public	"numeric" | "2-digit"	Specifies the day format to display.
dayPeriod?	public	"narrow" | "short" | "long"	Format for displaying the day period (e.g., AM/PM).
era?	public	"long" | "short" | "narrow"	Controls the display of the era (e.g., AD, BC) in the formatted date.
formatMatcher?	public	"best fit" | "basic"	Algorithm for matching the locale.
fractionalSecondDigits?	public	1 | 2 | 3	Number of fractional second digits to include. Defaults to the locale's setting if unspecified.
hour?	public	"numeric" | "2-digit"	Specifies the hour format.
hour12?	public	boolean	Use 12-hour or 24-hour time format. Defaults to locale settings if unspecified.
hourCycle?	public	"h11" | "h12" | "h23" | "h24"	Specifies the hour cycle for formatting. Defaults to the locale's hour cycle if unspecified.
localeMatcher?	public	"best fit" | "lookup"	Locale for formatting. Defaults to the system's locale if not specified.
minute?	public	"numeric" | "2-digit"	Format for displaying minutes.
month?	public	"numeric" | "2-digit" | "long" | "short" | "narrow"	Specifies how the month should be displayed.
numberingSystem?	public	string	Numbering system for formatting. Defaults to the locale's system if unspecified.
parts?	public	(Intl.DateTimeFormatPartTypes | `${"startRange" | "endRange" | "shared"}-${Intl.DateTimeFormatPartTypes}`)[]	Specifies which parts to include in the formatted output. If omitted, all parts are included by default.
second?	public	"numeric" | "2-digit"	Format for displaying seconds.
timeStyle?	public	"full" | "long" | "medium" | "short"	Style for time formatting. Defaults to locale-based style if unspecified.
timeZone?	public	string	Time zone for formatting. Defaults to the system's time zone if unspecified.
timeZoneName?	public	"short" | "long" | "shortOffset" | "longOffset" | "shortGeneric" | "longGeneric"	Specifies how the time zone name should be formatted.
weekday?	public	"long" | "short" | "narrow"	Specifies how the weekday should be displayed.
year?	public	"numeric" | "2-digit"	Specifies the year format.