Documentation / jalali-js / ValueFormat

Type Alias: ValueFormat

ValueFormat = "gregorian-iso" | "date" | "epoch" | "jalali-iso" | "jalali-object"

Defined in: storage-value.ts:13

How toStorageValue() shapes its output. 'gregorian-iso' is the default: see architecture.md's "Display value against storage value" for why a calendar-agnostic value is the default rather than the display calendar's own representation. The 'jalali-*' formats are named for their original use case (an application that must persist Jalali dates as such) but work the same way for whatever calendar system the date's own system is: they give that system's native fields, unconverted, rather than the Gregorian equivalent.