hAPIboo API reference
Preparing search index...
@hapiboo/date
DateObject
Class DateObject
Index
Accessors
_
value
day
hour
month
weekday
year
Methods
add
Day
add
Hour
add
Milisecond
add
Minute
add
Month
add
Second
add
Year
compare
equals
get
Days
Difference
get
Hours
Difference
is
Date
Between
is
Greater
is
Greater
Or
Equal
is
Holiday
is
Smaller
is
Smaller
Or
Equal
is
Weekday
is
Weekend
remove
Days
remove
Hours
remove
Minutes
reset
Day
reset
Year
same
Day
to
Local
Date
Short
to
Month
Short
String
to
String
to
Utc
to
Weekday
String
value
Of
now
set
start
Of
Month
start
Of
Week
start
Of
Year
today
yesterday
Accessors
_
value
get
_value
()
:
string
Returns
string
day
get
day
()
:
number
Returns
number
hour
get
hour
()
:
number
Returns
number
month
get
month
()
:
number
Returns
number
weekday
get
weekday
()
:
number
Returns
number
year
get
year
()
:
number
Returns
number
Methods
add
Day
addDay
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Hour
addHour
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Milisecond
addMilisecond
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Minute
addMinute
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Month
addMonth
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Second
addSecond
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
add
Year
addYear
(
count
:
number
)
:
DateObject
Parameters
count
:
number
Returns
DateObject
compare
compare
(
dateToCompare
:
DateObject
)
:
number
Parameters
dateToCompare
:
DateObject
Returns
number
equals
equals
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
get
Days
Difference
getDaysDifference
(
dateToCompare
:
DateObject
)
:
number
Parameters
dateToCompare
:
DateObject
Returns
number
get
Hours
Difference
getHoursDifference
(
dateToCompare
:
DateObject
)
:
number
Parameters
dateToCompare
:
DateObject
Returns
number
is
Date
Between
isDateBetween
(
startDate
:
DateObject
,
endDate
:
DateObject
)
:
boolean
Parameters
startDate
:
DateObject
endDate
:
DateObject
Returns
boolean
is
Greater
isGreater
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
is
Greater
Or
Equal
isGreaterOrEqual
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
is
Holiday
isHoliday
()
:
boolean
Returns
boolean
is
Smaller
isSmaller
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
is
Smaller
Or
Equal
isSmallerOrEqual
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
is
Weekday
isWeekday
()
:
boolean
Returns
boolean
is
Weekend
isWeekend
()
:
boolean
Returns
boolean
remove
Days
removeDays
()
:
DateObject
Returns
DateObject
remove
Hours
removeHours
()
:
DateObject
Returns
DateObject
remove
Minutes
removeMinutes
()
:
DateObject
Returns
DateObject
reset
Day
resetDay
()
:
DateObject
Returns
DateObject
reset
Year
resetYear
()
:
DateObject
Returns
DateObject
same
Day
sameDay
(
dateToCompare
:
DateObject
)
:
boolean
Parameters
dateToCompare
:
DateObject
Returns
boolean
to
Local
Date
Short
toLocalDateShort
(
locale
:
string
)
:
string
Parameters
locale
:
string
Returns
string
to
Month
Short
String
toMonthShortString
()
:
string
Returns
string
to
String
toString
()
:
string
Returns
string
to
Utc
toUtc
()
:
string
Returns
string
to
Weekday
String
toWeekdayString
()
:
string
Returns
string
value
Of
valueOf
()
:
number
Returns
number
Static
now
now
()
:
DateObject
Returns
DateObject
Static
set
set
(
epochMilliseconds
:
number
)
:
DateObject
Parameters
epochMilliseconds
:
number
Returns
DateObject
Static
start
Of
Month
startOfMonth
()
:
DateObject
Returns
DateObject
Static
start
Of
Week
startOfWeek
()
:
DateObject
Returns
DateObject
Static
start
Of
Year
startOfYear
()
:
DateObject
Returns
DateObject
Static
today
today
()
:
DateObject
Returns
DateObject
Static
yesterday
yesterday
()
:
DateObject
Returns
DateObject
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Accessors
_
value
day
hour
month
weekday
year
Methods
add
Day
add
Hour
add
Milisecond
add
Minute
add
Month
add
Second
add
Year
compare
equals
get
Days
Difference
get
Hours
Difference
is
Date
Between
is
Greater
is
Greater
Or
Equal
is
Holiday
is
Smaller
is
Smaller
Or
Equal
is
Weekday
is
Weekend
remove
Days
remove
Hours
remove
Minutes
reset
Day
reset
Year
same
Day
to
Local
Date
Short
to
Month
Short
String
to
String
to
Utc
to
Weekday
String
value
Of
now
set
start
Of
Month
start
Of
Week
start
Of
Year
today
yesterday
hAPIboo API reference
Loading...