Documentation / jalali-js / CalendarEngine

Interface: CalendarEngine

Defined in: calendar-engine.ts:19

The seam between a calendar system's rules and the rest of jalali-js. Adding a calendar later means writing one of these, not changing any other module.

A Julian Day Number (JDN) is a continuous day count with no calendar of its own; every engine converts to and from it, and that is the only path between two calendar systems. "Julian" here names the day-count system, not the Julian calendar.

Properties

monthsInYear

readonly monthsInYear: number

Defined in: calendar-engine.ts:21

---

system

readonly system: string

Defined in: calendar-engine.ts:20

Methods

daysInMonth()

daysInMonth(year, month): number

Defined in: calendar-engine.ts:23

Parameters

year

number

month

number

Returns

number

---

fromJulianDayNumber()

fromJulianDayNumber(jdn): CalendarDateFields

Defined in: calendar-engine.ts:25

Parameters

jdn

number

Returns

CalendarDateFields

---

isLeapYear()

isLeapYear(year): boolean

Defined in: calendar-engine.ts:22

Parameters

year

number

Returns

boolean

---

toJulianDayNumber()

toJulianDayNumber(date): number

Defined in: calendar-engine.ts:24

Parameters

date

CalendarDateFields

Returns

number