# new PersianAlgoDate(paramsopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
<optional> |
parameters that govern the settings and behaviour of this Persian date |
Extends
Members
number
# hour
The hour of the day. This can be a number from 0 to 23, as times are stored unambiguously in the 24-hour clock.
Methods
# after(dow) → {IDate}
Return a new date instance in the current calendar that represents the first instance of the given day of the week after the current date. The day of the week is encoded as a number where 0 = Sunday, 1 = Monday, etc.
Parameters:
| Name | Type | Description |
|---|---|---|
dow |
number
|
the day of the week after the current date that is being sought |
- Inherited From:
the date being sought
# before(dow) → {IDate}
Return a new date instance in the current calendar that represents the first instance of the given day of the week before the current date. The day of the week is encoded as a number where 0 = Sunday, 1 = Monday, etc.
Parameters:
| Name | Type | Description |
|---|---|---|
dow |
number
|
the day of the week before the current date that is being sought |
- Inherited From:
the date being sought
# protected firstSunday(year) → {number}
Return the rd number of the first Sunday of the given ISO year.
Parameters:
| Name | Type | Description |
|---|---|---|
year |
number
|
the year for which the first Sunday is being sought |
- Inherited From:
the rd of the first Sunday of the ISO year
number
# getCalendar() → {string}
Return the name of the calendar that governs this date.
a string giving the name of the calendar
string
# getDayOfWeek() → {number}
Return the day of the week of this date. The day of the week is encoded as number from 0 to 6, with 0=Sunday, 1=Monday, etc., until 6=Saturday.
the day of the week
number
# getDayOfYear() → {number}
Return the ordinal day of the year. Days are counted from 1 and proceed linearly up to 365, regardless of months or weeks, etc. That is, Farvardin 1st is day 1, and December 31st is 365 in regular years, or 366 in leap years.
the ordinal day of the year
number
# getEra() → {number}
Return the era for this date as a number. The value for the era for Persian calendars is -1 for "before the persian era" (BP) and 1 for "the persian era" (anno persico or AP). BP dates are any date before Farvardin 1, 1 AP. In the proleptic Persian calendar, there is a year 0, so any years that are negative or zero are BP.
1 if this date is in the common era, -1 if it is before the common era
number
# getJSDate() → {Date|undefined}
Return a Javascript Date object that is equivalent to this date object.
- Inherited From:
a javascript Date object
Date
|
undefined
# getJulianDay() → {number}
Return the Julian Day equivalent to this calendar date as a number.
- Inherited From:
the julian date equivalent of this date
number
# protected getRataDie() → {number}
Return the Rata Die (fixed day) number of this date.
- Inherited From:
the rd date as a number
number
# getTime() → {number}
Return the unix time equivalent to this date instance. Unix time is the number of milliseconds since midnight on Jan 1, 1970 UTC (Gregorian). This method only returns a valid number for dates between midnight, Jan 1, 1970 UTC (Gregorian) and Jan 19, 2038 at 3:14:07am UTC (Gregorian) when the unix time runs out. If this instance encodes a date outside of that range, this method will return -1. For date types that are not Gregorian, the point in time represented by this date object will only give a return value if it is in the correct range in the Gregorian calendar as given previously.
- Inherited From:
a number giving the unix time, or -1 if the date is outside the valid unix time range
number
# getTimeExtended() → {number}
Return the extended unix time equivalent to this Gregorian date instance. Unix time is the number of milliseconds since midnight on Jan 1, 1970 UTC. Traditionally unix time (or the type "time_t" in C/C++) is only encoded with an unsigned 32 bit integer, and thus runs out on Jan 19, 2038. However, most Javascript engines encode numbers well above 32 bits and the Date object allows you to encode up to 100 million days worth of time after Jan 1, 1970, and even more interestingly, 100 million days worth of time before Jan 1, 1970 as well. This method returns the number of milliseconds in that extended range. If this instance encodes a date outside of that range, this method will return NaN.
- Inherited From:
a number giving the extended unix time, or Nan if the date is outside the valid extended unix time range
number
# getTimeZone() → {string|undefined}
Return the time zone associated with this date, or undefined if none was specified in the constructor.
- Inherited From:
the name of the time zone for this date instance
string
|
undefined
# getWeekOfMonth(locale) → {number}
Return the ordinal number of the week within the month. The first week of a month is the first one that contains 4 or more days in that month. If any days precede this first week, they are marked as being in week 0. This function returns values from 0 through 6.
The locale is a required parameter because different locales that use the same Gregorian calendar consider different days of the week to be the beginning of the week. This can affect the week of the month in which some days are located.
Parameters:
| Name | Type | Description |
|---|---|---|
locale |
Locale
|
string
|
the locale or locale spec to use when figuring out the first day of the week |
- Inherited From:
the ordinal number of the week within the current month
number
# getWeekOfYear() → {number}
Return the ISO 8601 week number in the current year for the current date. The week number ranges from 0 to 55, as some years have 55 weeks assigned to them in some calendars.
- Inherited From:
the week number for the current date
number
# protected newRd(paramsopt) → {RataDie}
Return a new RD for this date type using the given params.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
<optional> |
the parameters used to create this rata die instance |
the new RD instance for the given params
# onOrAfter(dow) → {IDate}
Return a new Gregorian date instance that represents the first instance of the given day of the week on or after the current date. The day of the week is encoded as a number where 0 = Sunday, 1 = Monday, etc.
Parameters:
| Name | Type | Description |
|---|---|---|
dow |
number
|
the day of the week on or after the current date that is being sought |
- Inherited From:
the date being sought
# onOrBefore(dow) → {IDate}
Return a new Gregorian date instance that represents the first instance of the given day of the week on or before the current date. The day of the week is encoded as a number where 0 = Sunday, 1 = Monday, etc.
Parameters:
| Name | Type | Description |
|---|---|---|
dow |
number
|
the day of the week on or before the current date that is being sought |
- Inherited From:
the date being sought
# setJulianDay(date)
Set the date of this instance using a Julian Day.
Parameters:
| Name | Type | Description |
|---|---|---|
date |
number
|
JulianDay
|
the Julian Day to use to set this date |
- Inherited From:
# protected setRd(rd)
Set the date components of this instance based on the given rd.
Parameters:
| Name | Type | Description |
|---|---|---|
rd |
number
|
the rata die date to set |
- Inherited From:
# setTime(millis)
Set the time of this instance according to the given unix time. Unix time is the number of milliseconds since midnight on Jan 1, 1970.
Parameters:
| Name | Type | Description |
|---|---|---|
millis |
number
|
the unix time to set this date to in milliseconds |
- Inherited From:
# setTimeZone(tzNameopt)
Set the time zone associated with this date.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
tzName |
string
|
<optional> |
the name of the time zone to set into this date instance, or "undefined" to unset the time zone |
- Inherited From: