Documentation / @jalali-js/i18n / FormatOptions

Interface: FormatOptions

Defined in: format.ts:7

Properties

numerals?

optional numerals?: NumeralStyle

Defined in: format.ts:13

Latin digits or the locale's own native digits. Default: the locale's defaultNumerals.

---

style?

optional style?: "long" | "short"

Defined in: format.ts:9

Long month/weekday names ("Mordad", "Monday") or short ones ("Mor", "Mon"). Default: 'long'.

---

template?

optional template?: string

Defined in: format.ts:15

A token template, e.g. 'YYYY/MM/DD'. When set, style and weekday are ignored.

---

weekday?

optional weekday?: boolean

Defined in: format.ts:11

Prefix the formatted date with its weekday name. Default: false.