Documentation / @jalali-js/i18n / LocalePack

Interface: LocalePack

Defined in: locale.ts:27

A complete data file for one language. Adding a locale is adding one more LocalePack, with no change to format() or any other code (see architecture.md's "Internationalization").

Properties

code

readonly code: string

Defined in: locale.ts:29

A BCP 47-ish language tag, e.g. 'en' or 'fa'. Not validated; used only as a label.

---

datePickerPlaceholder

readonly datePickerPlaceholder: string

Defined in: locale.ts:42

Placeholder text for a closed DatePicker/RangePicker with nothing selected yet, so a consumer who passes no placeholder of their own never sees a genuinely blank input.

---

defaultNumerals

readonly defaultNumerals: "latin" | "native"

Defined in: locale.ts:34

Which digit style format() uses when the caller does not ask for one explicitly.

---

digits

readonly digits: readonly string[]

Defined in: locale.ts:32

The 10 native digit characters, index 0-9. Latin digits are ['0', '1', ..., '9'].

---

direction

readonly direction: "ltr" | "rtl"

Defined in: locale.ts:30

---

monthNames

readonly monthNames: Record<CalendarSystem, MonthNames>

Defined in: locale.ts:38

Every calendar system this locale can format. A third calendar (Phase 12) adds a key here.

---

rangePickerPlaceholder

readonly rangePickerPlaceholder: string

Defined in: locale.ts:43

---

weekdayNames

readonly weekdayNames: WeekdayNames

Defined in: locale.ts:39

---

weekdaySeparator

readonly weekdaySeparator: string

Defined in: locale.ts:36

Joins a weekday name onto the rest of a formatted date, e.g. ', ' or '، '.