# PersianDateClass
**Kind**: global class
* [PersianDateClass](#PersianDateClass)
* [new PersianDateClass(input)](#new_PersianDateClass_new)
* _instance_
* [.setup(input)](#PersianDateClass+setup)
* [.rangeName()](#PersianDateClass+rangeName) ⇒ \*
* [.toLeapYearMode(input)](#PersianDateClass+toLeapYearMode) ⇒ [PersianDateClass](#PersianDateClass)
* [.toCalendar(input)](#PersianDateClass+toCalendar) ⇒ [PersianDateClass](#PersianDateClass)
* [.toLocale(input)](#PersianDateClass+toLocale) ⇒ [PersianDateClass](#PersianDateClass)
* [.isPersianDate(obj)](#PersianDateClass+isPersianDate) ⇒ boolean
* [.clone()](#PersianDateClass+clone) ⇒ PersianDate
* [.algorithmsCalc(dateArray)](#PersianDateClass+algorithmsCalc) ⇒ \*
* [.calendar()](#PersianDateClass+calendar) ⇒ \*
* [.duration(input, key)](#PersianDateClass+duration) ⇒ Duration
* [.isDuration(obj)](#PersianDateClass+isDuration) ⇒ boolean
* [.years(input)](#PersianDateClass+years) ⇒ \*
* [.year(input)](#PersianDateClass+year) ⇒ \*
* [.month(input)](#PersianDateClass+month) ⇒ \*
* [.days()](#PersianDateClass+days) ⇒ function \| Date.toJSON.day \| date_json.day \| PersianDate.day \| day \| output.day \| \*
* [.day()](#PersianDateClass+day) ⇒ function \| Date.toJSON.day \| date_json.day \| PersianDate.day \| day \| output.day \| \*
* [.dates(input)](#PersianDateClass+dates) ⇒ \*
* [.date(input)](#PersianDateClass+date) ⇒ \*
* [.hour(input)](#PersianDateClass+hour) ⇒ \*
* [.hours(input)](#PersianDateClass+hours) ⇒ \*
* [.minute(input)](#PersianDateClass+minute) ⇒ \*
* [.minutes(input)](#PersianDateClass+minutes) ⇒ \*
* [.second(input)](#PersianDateClass+second) ⇒ \*
* [.seconds(input)](#PersianDateClass+seconds) ⇒ \*
* [.millisecond(input)](#PersianDateClass+millisecond) ⇒ \*
* [.milliseconds(input)](#PersianDateClass+milliseconds) ⇒ \*
* [.unix(timestamp)](#PersianDateClass+unix) ⇒ \*
* [.valueOf()](#PersianDateClass+valueOf) ⇒ \*
* [.getFirstWeekDayOfMonth(year, month)](#PersianDateClass+getFirstWeekDayOfMonth) ⇒ \*
* [.diff(input, val, asFloat)](#PersianDateClass+diff) ⇒ \*
* [.startOf(key)](#PersianDateClass+startOf) ⇒ \*
* [.endOf(key)](#PersianDateClass+endOf) ⇒ \*
* [.sod()](#PersianDateClass+sod) ⇒ \*
* [.eod()](#PersianDateClass+eod) ⇒ \*
* [.zone()](#PersianDateClass+zone) ⇒ \*
* [.local()](#PersianDateClass+local) ⇒ PersianDate
* [.utc(input)](#PersianDateClass+utc) ⇒ \*
* [.isUtc()](#PersianDateClass+isUtc) ⇒ boolean
* [.isDST()](#PersianDateClass+isDST) ⇒ boolean
* [.isLeapYear()](#PersianDateClass+isLeapYear) ⇒ boolean
* [.daysInMonth(yearInput, monthInput)](#PersianDateClass+daysInMonth) ⇒ number
* [.toDate()](#PersianDateClass+toDate) ⇒ \* \| PersianDate.gDate
* [.toArray()](#PersianDateClass+toArray) ⇒ array
* [.formatNumber()](#PersianDateClass+formatNumber) ⇒ \*
* [.format(inputString)](#PersianDateClass+format) ⇒ \*
* [.add(key, value)](#PersianDateClass+add) ⇒ PersianDate
* [.subtract(key, value)](#PersianDateClass+subtract) ⇒ PersianDate
* [.isSameDay(dateB)](#PersianDateClass+isSameDay) ⇒ [PersianDateClass](#PersianDateClass) \| \* \| boolean
* [.isSameMonth(dateA, dateB)](#PersianDateClass+isSameMonth) ⇒ \* \| boolean
* _static_
* [.rangeName()](#PersianDateClass.rangeName) ⇒ \*
* [.toLeapYearMode(input)](#PersianDateClass.toLeapYearMode) ⇒ [PersianDateClass](#PersianDateClass)
* [.toCalendar(input)](#PersianDateClass.toCalendar) ⇒ [PersianDateClass](#PersianDateClass)
* [.toLocale(input)](#PersianDateClass.toLocale) ⇒ [PersianDateClass](#PersianDateClass)
* [.isPersianDate(obj)](#PersianDateClass.isPersianDate) ⇒ boolean
* [.duration(input, key)](#PersianDateClass.duration) ⇒ Duration
* [.isDuration(obj)](#PersianDateClass.isDuration) ⇒ boolean
* [.getFirstWeekDayOfMonth(year, month)](#PersianDateClass.getFirstWeekDayOfMonth) ⇒ \*
* [.utc(input)](#PersianDateClass.utc) ⇒ \*
* [.isSameDay(dateA, dateB)](#PersianDateClass.isSameDay) ⇒ boolean
* [.isSameMonth(dateA, dateB)](#PersianDateClass.isSameMonth) ⇒ boolean
## new PersianDateClass(input)
persian date class
## persianDateClass.setup(input)
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.rangeName() ⇒ \*
Helper method that return date range name like week days name, month names, month days names (specially in persian calendar).
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.toLeapYearMode(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.toCalendar(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.toLocale(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.isPersianDate(obj) ⇒ boolean
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.clone() ⇒ PersianDate
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.algorithmsCalc(dateArray) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.calendar() ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.duration(input, key) ⇒ Duration
return Duration object
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.isDuration(obj) ⇒ boolean
check if passed object is duration
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.years(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.year(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.month(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.days() ⇒ function \| Date.toJSON.day \| date_json.day \| PersianDate.day \| day \| output.day \| \*
Day of week
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.day() ⇒ function \| Date.toJSON.day \| date_json.day \| PersianDate.day \| day \| output.day \| \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.dates(input) ⇒ \*
Day of Months
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.date(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.hour(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.hours(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.minute(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.minutes(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.second(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.seconds(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.millisecond(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Returns**: \* - Getter Setter
## persianDateClass.milliseconds(input) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.unix(timestamp) ⇒ \*
Return Unix Timestamp (1318874398)
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.valueOf() ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.getFirstWeekDayOfMonth(year, month) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.diff(input, val, asFloat) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.startOf(key) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.endOf(key) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.sod() ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.eod() ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.zone() ⇒ \*
Get the timezone offset in minutes.
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.local() ⇒ PersianDate
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.utc(input) ⇒ \*
Current date/time in UTC mode
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.isUtc() ⇒ boolean
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.isDST() ⇒ boolean
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Link**: https://fa.wikipedia.org/wiki/%D8%B3%D8%A7%D8%B9%D8%AA_%D8%AA%D8%A7%D8%A8%D8%B3%D8%AA%D8%A7%D9%86%DB%8C
## persianDateClass.isLeapYear() ⇒ boolean
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.daysInMonth(yearInput, monthInput) ⇒ number
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
| Param |
| yearInput |
| monthInput |
## persianDateClass.toDate() ⇒ \* \| PersianDate.gDate
Return Native Javascript Date
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.toArray() ⇒ array
Returns Array Of Persian Date
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.formatNumber() ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.format(inputString) ⇒ \*
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.add(key, value) ⇒ PersianDate
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.subtract(key, value) ⇒ PersianDate
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
## persianDateClass.isSameDay(dateB) ⇒ [PersianDateClass](#PersianDateClass) \| \* \| boolean
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## persianDateClass.isSameMonth(dateA, dateB) ⇒ \* \| boolean
check two for month similarity
**Kind**: instance method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.rangeName() ⇒ \*
Helper method that return date range name like week days name, month names, month days names (specially in persian calendar).
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.toLeapYearMode(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.toCalendar(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.toLocale(input) ⇒ [PersianDateClass](#PersianDateClass)
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.isPersianDate(obj) ⇒ boolean
**Kind**: static method of [PersianDateClass](#PersianDateClass)
## PersianDateClass.duration(input, key) ⇒ Duration
return Duration object
**Kind**: static method of [PersianDateClass](#PersianDateClass)
## PersianDateClass.isDuration(obj) ⇒ boolean
check if passed object is duration
**Kind**: static method of [PersianDateClass](#PersianDateClass)
## PersianDateClass.getFirstWeekDayOfMonth(year, month) ⇒ \*
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.utc(input) ⇒ \*
**Kind**: static method of [PersianDateClass](#PersianDateClass)
## PersianDateClass.isSameDay(dateA, dateB) ⇒ boolean
check if a date is same as b
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
## PersianDateClass.isSameMonth(dateA, dateB) ⇒ boolean
check if a month is same as b
**Kind**: static method of [PersianDateClass](#PersianDateClass)
**Since**: 1.0.0
| Param | Type |
| dateA | Date |
| dateB | Date |