Class

PersianCal

PersianCal(optionsopt)

Construct a new Persian astronomical (Hijjri) calendar object. This class encodes information about a Persian calendar. This class differs from the Persian calendar in that the leap years are calculated based on the astronomical observations of the sun in Teheran, instead of calculating the leap years based on a regular cyclical rhythm algorithm.

Constructor

# new PersianCal(optionsopt)

Parameters:
Name Type Attributes Description
options Object <optional>

Options governing the construction of this instance

View Source PersianCal.js, line 37

Extends

Methods

# getMonLength(month, year) → {number}

Return the number of days in a particular month in a particular year. This function can return a different number for a month depending on the year because of things like leap years.

Parameters:
Name Type Description
month number

the month for which the length is sought

year number

the year within which that month can be found

Overrides:

View Source PersianCal.js, line 88

the number of days within the given month in the given year

number

# getNumMonths(year) → {number}

Return the number of months in the given year. The number of months in a year varies for some luni-solar calendars because in some years, an extra month is needed to extend the days in a year to an entire solar year. The month is represented as a 1-based number where 1=first month, 2=second month, etc.

Parameters:
Name Type Description
year number

a year for which the number of months is sought

Overrides:

View Source PersianCal.js, line 75

The number of months in the given year

number

# getType() → {string}

Return the type of this calendar.

Overrides:

View Source PersianCal.js, line 131

the name of the type of this calendar

string

# isLeapYear(year) → {boolean}

Return true if the given year is a leap year in the Persian astronomical calendar.

Parameters:
Name Type Description
year number

the year for which the leap year information is being sought

Overrides:

View Source PersianCal.js, line 102

true if the given year is a leap year

boolean