Skip to content

Date formatting

NepaliDateFormat formats a NepaliDateTime, or any DateTime, as text in the Bikram Sambat calendar. It works like DateFormat from package:intl:

  • the same pattern letters (yyyy-MM-dd, EEE, MMM d)
  • the same skeleton constructors (NepaliDateFormat.yMMMd()) and constants (NepaliDateFormat.YEAR_MONTH_DAY)
  • the same addPattern / add_* composition

Skeletons are laid out like intl’s en locale in English and its ne locale in Nepali. Nepali output uses Devanagari digits.

final date = NepaliDateTime.parse('2072-06-03T17:00:00');
NepaliDateFormat.MEd().format(date); // Sun, 6/3
NepaliDateFormat.MMMMEEEEd().format(date); // Sunday, Ashwin 3
NepaliDateFormat.jms().format(date); // 5:00:00 PM
NepaliDateFormat.yMd().add_jm().format(date); // 6/3/2072 5:00 PM
NepaliDateFormat.yMd(.nepali).add_jm().format(date); // २०७२-०६-०३ १७:००
NepaliDateFormat([String? pattern, Language? language])
  • pattern is either a skeleton name such as 'yMMMd', which is resolved to the layout for the language, or an explicit pattern such as 'MMMM d, y'.

  • Without a pattern, the format is yMMMMd jms:

    NepaliDateFormat().format(date); // Ashwin 3, 2072 5:00:00 PM
    NepaliDateFormat(null, .nepali).format(date); // २०७२ आश्विन ३ १७:००:००
  • language defaults to NepaliUtils.currentLanguage at the moment you create the formatter.

The resolved pattern is available as pattern:

NepaliDateFormat.yMd().pattern; // M/d/y
NepaliDateFormat.yMd(.nepali).pattern; // y-MM-dd
NepaliDateFormat().pattern; // MMMM d, y h:mm:ss a

format accepts any DateTime. A plain DateTime is converted with toNepaliDateTime() first, which keeps its time zone:

NepaliDateFormat.yMMMMd().format(DateTime(2019, 8, 3)); // Shrawan 18, 2076

parseAndFormat(string) parses a BS date string with NepaliDateTime.parse, then formats it:

NepaliDateFormat.yMMMMEEEEd().parseAndFormat('2080-01-01'); // Friday, Baishakh 1, 2080

Each skeleton is a named constructor and a constant. For example, NepaliDateFormat.yMMMd() is the same as NepaliDateFormat(NepaliDateFormat.YEAR_ABBR_MONTH_DAY) and NepaliDateFormat('yMMMd').

Outputs for 2076-08-05 21:04:25 Nepal Time:

Constructor Constant English Nepali
d DAY 5 ५
E ABBR_WEEKDAY Thu बिहि
EEEE WEEKDAY Thursday बिहिबार
EEEEE — T बि
LLL ABBR_STANDALONE_MONTH Marg मं
LLLL STANDALONE_MONTH Mangsir मंसिर
M NUM_MONTH 8 ८
Md NUM_MONTH_DAY 8/5 ०८-०५
MEd NUM_MONTH_WEEKDAY_DAY Thu, 8/5 ०८-०५, बिहि
MMM ABBR_MONTH Marg मं
MMMd ABBR_MONTH_DAY Marg 5 मं ५
MMMEd ABBR_MONTH_WEEKDAY_DAY Thu, Marg 5 मं ५, बिहि
MMMM MONTH Mangsir मंसिर
MMMMd MONTH_DAY Mangsir 5 मंसिर ५
MMMMEEEEd MONTH_WEEKDAY_DAY Thursday, Mangsir 5 मंसिर ५, बिहिबार
QQQ ABBR_QUARTER Q3 तेस्रो त्रैमासिक
QQQQ QUARTER 3rd quarter तेस्रो त्रैमासिक
y YEAR 2076 २०७६
yM YEAR_NUM_MONTH 8/2076 २०७६-०८
yMd YEAR_NUM_MONTH_DAY 8/5/2076 २०७६-०८-०५
yMEd YEAR_NUM_MONTH_WEEKDAY_DAY Thu, 8/5/2076 २०७६-०८-०५, बिहि
yMMM YEAR_ABBR_MONTH Marg 2076 २०७६ मं
yMMMd YEAR_ABBR_MONTH_DAY Marg 5, 2076 २०७६ मं ५
yMMMEd YEAR_ABBR_MONTH_WEEKDAY_DAY Thu, Marg 5, 2076 २०७६ मं ५, बिहि
yMMMM YEAR_MONTH Mangsir 2076 २०७६ मंसिर
yMMMMd YEAR_MONTH_DAY Mangsir 5, 2076 २०७६ मंसिर ५
yMMMMEEEEd YEAR_MONTH_WEEKDAY_DAY Thursday, Mangsir 5, 2076 २०७६ मंसिर ५, बिहिबार
yQQQ YEAR_ABBR_QUARTER Q3 2076 २०७६ तेस्रो त्रैमासिक
yQQQQ YEAR_QUARTER 3rd quarter 2076 २०७६ तेस्रो त्रैमासिक
H HOUR24 21 २१
Hm HOUR24_MINUTE 21:04 २१:०४
Hms HOUR24_MINUTE_SECOND 21:04:25 २१:०४:२५
j HOUR 9 PM २१
jm HOUR_MINUTE 9:04 PM २१:०४
jms HOUR_MINUTE_SECOND 9:04:25 PM २१:०४:२५
jmv HOUR_MINUTE_GENERIC_TZ 9:04 PM NPT २१:०४ NPT
jmz HOUR_MINUTE_TZ 9:04 PM NPT २१:०४ NPT
jv HOUR_GENERIC_TZ 9 PM NPT २१h NPT
jz HOUR_TZ 9 PM NPT २१h NPT
m MINUTE 4 ४
ms MINUTE_SECOND 04:25 ०४:२५
s SECOND 25 २५

The j skeletons use the clock that is usual for the language: 12-hour with AM/PM in English, and 24-hour in Nepali.

Write explicit patterns with these letters. Repeating a letter changes the width or form.

Outputs for 2081-12-30 00:05:09.120450 and 2090-11-01 21:59:59 Nepal Time:

Pattern Meaning English Nepali
G era BS बि सं
GGGG era, long Bikram Sambat बिक्रम संबत
y, yyyy year 2081 २०८१
yy year, 2 digits 81 ८१
Q / QQ quarter 4 / 04 ४ / ०४
QQQ quarter, short Q4 चौथो त्रैमासिक
QQQQ quarter, long 4th quarter चौथो त्रैमासिक
M / MM month number 12 / 12 · 11 / 11 १२ / १२ · ११ / ११
MMM month, short Cha · Fal चै · फा
MMMM month Chaitra · Falgun चैत्र · फाल्गुण
MMMMM month, narrow C · F चै · फा
MMMMMM month, colloquial Chait · Fagun चैत · फागुन
L…LLLLLL standalone month same as M…MMMMMM same as M…MMMMMM
d / dd day of month 30 · 1 / 01 ३० · १ / ०१
D day of year 365 · 306 ३६५ · ३०६
E, EE, EEE weekday, short Sat · Mon शनि · सोम
EEEE weekday Saturday · Monday शनिबार · सोमबार
EEEEE weekday, narrow S · M श · सो
ccc / cccc standalone weekday Sat / Saturday शनि / शनिबार
a AM/PM, or time of day in Nepali AM · PM बिहान · बेलुकी
h / hh hour 1–12 12 · 9 / 09 १२ · ९ / ०९
H / HH hour 0–23 0 / 00 · 21 ० / ०० · २१
K hour 0–11 0 · 9 ० · ९
k hour 1–24 24 · 21 २४ · २१
m / mm minute 5 / 05 ५ / ०५
s / ss second 9 / 09 ९ / ०९
S, SSS fraction of a second, milliseconds 120 १२०
SSSSSS fraction of a second, microseconds 120450 १२०४५०
z, v time zone NPT NPT
zzzz time zone, long Nepal Time नेपाल समय
Z offset +0545 +०५४५
ZZZZ offset, GMT form GMT+05:45 GMT+०५:४५
'text' quoted literal 'at' → at
'' a single quote ''yy → ’81

In Nepali, a gives the time of day instead of AM/PM:

for (final hour in [5, 12, 14, 18, 21]) {
NepaliDateFormat('h a', .nepali).format(NepaliDateTime(2080, 1, 1, hour));
}
// ५ बिहान, १२ मध्यान्न, २ दिउसो, ६ साँझ, ९ बेलुकी

The time-zone letters show the zone of the value: NPT for Nepal Time, UTC for UTC, and the device’s zone name for local values. (intl leaves them empty.)

NepaliDateFormat('HH:mm z').format(NepaliDateTime.nepal(2080, 1, 1, 9)); // 09:00 NPT
NepaliDateFormat('HH:mm Z').format(NepaliDateTime.utc(2080, 1, 1, 9)); // 09:00 +0000
final date = NepaliDateTime.parse('2072-06-03T17:00:00');
NepaliDateFormat("yyyy.MM.dd G 'at' HH:mm:ss").format(date); // 2072.06.03 BS at 17:00:00
NepaliDateFormat("EEE, MMM d, ''yy").format(date); // Sun, Ash 3, '72
NepaliDateFormat('h:mm a').format(date); // 5:00 PM
NepaliDateFormat("hh 'o''clock' a").format(date); // 05 o'clock PM
NepaliDateFormat('yyyy.MMMM.dd GGGG hh:mm a').format(date);
// 2072.Ashwin.03 Bikram Sambat 05:00 PM
NepaliDateFormat('yyyy.MMMM.dd GGGG hh:mm a', .nepali).format(date);
// २०७२.आश्विन.०३ बिक्रम संबत ०५:०० साँझ

addPattern(pattern, [separator = ' ']) returns a new formatter: this formatter’s pattern, then the separator, then pattern. A skeleton name passed to it is resolved, as in the constructor. The add_*() methods add the skeleton they’re named after:

NepaliDateFormat.yMd().add_jm().format(date); // 6/3/2072 5:00 PM
NepaliDateFormat.yMMMd().addPattern('Hm', ' · ').format(date); // Ash 3, 2072 · 17:00
NepaliDateFormat.yMMMMd().addPattern("'at' h:mm a").format(date); // Ashwin 3, 2072 at 5:00 PM
NepaliDateFormat.yMMMMEEEEd(.nepali).format(date); // २०७२ आश्विन ३, आइतबार
NepaliDateFormat('EEE, d MMM y', .nepali).format(NepaliDateTime(2081, 12, 30));
// शनि, ३० चै २०८१

See Language for details.

The formatter prints the fields in the value’s own time zone. To format an instant as Nepal Time, convert it first:

final instant = DateTime.utc(2024, 1, 1);
NepaliDateFormat('yyyy-MM-dd HH:mm').format(instant);
// 2080-09-16 00:00 (UTC fields)
NepaliDateFormat('yyyy-MM-dd HH:mm').format(instant.toNepaliDateTime().toNepalTime());
// 2080-09-16 05:45