O3 Framework / FormatDateOptions
FormatDateOptions =
object
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:172
optionalcalendar:string
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:176
The calendar to use when formatting this date.
day:
boolean
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:192
Whether to include the day number
optionallocale:string
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:180
The locale to use when formatting this date
mode:
FormatDateMode
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:185
standard: “03 Feb 2022”wide: “03 — Feb — 2022”month:
boolean
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:194
Whether to include the month number
noToday:
boolean
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:205
Disables the special handling of dates that are today. If false (the default), then dates that are today will be formatted as “Today” in the locale language. If true, then dates that are today will be formatted the same as all other dates.
optionalnumberingSystem:string
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:198
The unicode numbering system to use
time:
true|false|"for today"
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:190
Whether the time should be included in the output always (true),
never (false), or only when the input date is today (for today).
year:
boolean
Defined in: packages/framework/esm-utils/src/dates/date-util.ts:196
Whether to include the year