Documentation / @jalali-js/i18n / format

Function: format()

format(date, locale, options?): string

Defined in: format.ts:23

Formats date for display, in locale's language, using date.system's own month names. This is a display-only concern (see architecture.md's "Display value against storage value"): it never affects what toStorageValue() in jalali-js returns.

Parameters

date

AnyCalendarDate

locale

LocalePack

options?

FormatOptions = {}

Returns

string