Class

GregorianCal

GregorianCal(optionsopt)

Construct a new Gregorian calendar object. This class encodes information about a Gregorian calendar.

Constructor

# new GregorianCal(optionsopt)

Parameters:
Name Type Attributes Description
options Object <optional>

View Source GregorianCal.js, line 35

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 GregorianCal.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 GregorianCal.js, line 75

The number of months in the given year

number

# getType() → {string}

Return the type of this calendar.

Overrides:

View Source GregorianCal.js, line 113

the name of the type of this calendar

string

# isLeapYear(year) → {boolean}

Return true if the given year is a leap year in the Gregorian calendar. The year parameter may be given as a number, or as a GregDate object.

Parameters:
Name Type Description
year number | GregorianDate

the year for which the leap year information is being sought

Overrides:

View Source GregorianCal.js, line 102

true if the given year is a leap year

boolean