jalali-plugin-dayjs

This plugin is based on the jalaliday package. Since that package is no longer maintained, I have addressed and fixed various issues to ensure continued support and functionality.

Persian (Jalali, Khorshidi) Plugin for Day.js, jalali-plugin-dayjs add multi-calendar functionality to Day.js core regardless for of locale, so we can have Gregorian calendar is Persian locale of Jalali calendar in English locale
Unlike moment and becuase of immutablity of dayjs, there is no need for formats like jYYYY or jMM, in jalali-plugin-dayjs all formats are same and standard

📖 Release Notes

Installation

NPM

npm install --save jalali-plugin-dayjs

YARN

yarn add jalali-plugin-dayjs

Usage

1import dayjs from 'dayjs'
2import jalaliday from 'jalali-plugin-dayjs'
3
4dayjs.extend(jalaliday)

Changing calendar

If you want to all new instanses of dayjs use jalali calendar, you can set default calendar

1dayjs.calendar('jalali') // Jalali Calendar
2// OR
3dayjs.calendar('gregory') // Gregorian Calendar

also you can create a jalali date without changing default calendar

1const date = dayjs()
2const jalaliDate = date.calendar('jalali')

Parse Date

• Parse Gregory date

1const date = dayjs('2018-04-04T16:00:00.000Z');

• Parse Jalali date

1const date = dayjs('1398-10-17', { jalali: true });

Multiple Locale

with combination of calendar and locale we have multi language for real

1dayjs().calendar('jalali').locale('en').format('DD MMMM YYYY') // '13 Shahrivar 1397'
2dayjs().calendar('gregory').locale('fa').format('DD MMMM YYYY') // '04 سپتامبر 2018'

API

All Api operations of jalali-plugin-dayjs is same as Dayjs itself but calendar based, for more information checkout Dayjs API For a glance:

• API Reference
  • Parsing
    • Constructor dayjs(existing?: string | number | Date | Dayjs)
      • ISO 8601 string
      • Unix Timestamp (milliseconds since the Unix Epoch - Jan 1 1970, 12AM UTC)
      • Native Javascript Date object
    • Clone .clone() | dayjs(original: Dayjs)
    • Validation .isValid()
  • Get and Set
    • Year .year()
    • Month .month()
    • Day of the Month .date()
    • Day of the Week .day()
    • Hour .hour()
    • Minute .minute()
    • Second .second()
    • Millisecond .millisecond()
    • Set .set(unit: string, value: number)
  • Manipulating
    • Add .add(value: number, unit: string)
    • Subtract .subtract(value: number, unit: string)
    • Start of Time .startOf(unit: string)
    • End of Time .endOf(unit: string)
  • Displaying
    • Format .format(stringWithTokens: string)
      • List of all available formats
    • Difference .diff(compared: Dayjs, unit: string (default: 'milliseconds'), float?: boolean)
    • Unix Timestamp (milliseconds) .valueOf()
    • Unix Timestamp (seconds) .unix()
    • Days in the Month .daysInMonth()
    • As Javascript Date .toDate()
    • As Array .toArray()
    • As JSON .toJSON()
    • As ISO 8601 String .toISOString()
    • As Object .toObject()
    • As String .toString()
  • Query
    • Is Before .isBefore(compared: Dayjs)
    • Is Same .isSame(compared: Dayjs)
    • Is After .isAfter(compared: Dayjs)
    • Is a Dayjs .isDayjs()
  • Plugin APIs
    • RelativeTime
    • IsLeapYear
    • WeekOfYear
    • IsBetween