API / DateTime / DateTime

Defined in: src/typings/dateTime.ts:76

PropertiesProperties

Property	Type	Description
daysInMonth	() => number	Get the number of days in the current month.

MethodsMethods

add()add()

add(amount, unit?): DateTime

Defined in: src/typings/dateTime.ts:77

Parameters

Parameter	Type
amount	DurationInput
unit?	DurationUnit

Returns

DateTime

---

date()date()

Call Signature

date(): number

Defined in: src/typings/dateTime.ts:148

Returns

number

Call Signature

date(value): DateTime

Defined in: src/typings/dateTime.ts:149

Parameters

Parameter	Type
value	number

Returns

DateTime

---

day()day()

Call Signature

day(): number

Defined in: src/typings/dateTime.ts:107

Gets the day of the week, with Sunday as 0 and Saturday as 6.

Returns

number

Call Signature

day(value): DateTime

Defined in: src/typings/dateTime.ts:109

Sets the day of the week, with Sunday as 0 and Saturday as 6.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

dayOfYear()dayOfYear()

Call Signature

dayOfYear(): number

Defined in: src/typings/dateTime.ts:139

Gets the day of the year.

Returns

number

Call Signature

dayOfYear(value): DateTime

Defined in: src/typings/dateTime.ts:141

Sets the day of the year.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

diff()diff()

diff(amount, unit?, asFloat?): number

Defined in: src/typings/dateTime.ts:81

Parameters

Parameter	Type
amount	DateTimeInput
unit?	DurationUnit
asFloat?	boolean

Returns

number

---

endOf()endOf()

endOf(unitOfTime): DateTime

Defined in: src/typings/dateTime.ts:93

Parameters

Parameter	Type
unitOfTime	StartOfUnit

Returns

DateTime

---

format()format()

format(formatInput?): string

Defined in: src/typings/dateTime.ts:82

Parameters

Parameter	Type
formatInput?	FormatInput

Returns

string

---

from()from()

from(formaInput, withoutSuffix?): string

Defined in: src/typings/dateTime.ts:84

Parameters

Parameter	Type
formaInput	DateTimeInput
withoutSuffix?	boolean

Returns

string

---

fromNow()fromNow()

fromNow(withoutSuffix?): string

Defined in: src/typings/dateTime.ts:83

Parameters

Parameter	Type
withoutSuffix?	boolean

Returns

string

---

hour()hour()

Call Signature

hour(): number

Defined in: src/typings/dateTime.ts:150

Returns

number

Call Signature

hour(value): DateTime

Defined in: src/typings/dateTime.ts:151

Parameters

Parameter	Type
value	number

Returns

DateTime

---

isAfter()isAfter()

isAfter(input?): boolean

Defined in: src/typings/dateTime.ts:87

Parameters

Parameter	Type
input?	DateTimeInput

Returns

boolean

---

isBefore()isBefore()

isBefore(input?): boolean

Defined in: src/typings/dateTime.ts:86

Parameters

Parameter	Type
input?	DateTimeInput

Returns

boolean

---

isoWeek()isoWeek()

Call Signature

isoWeek(): number

Defined in: src/typings/dateTime.ts:129

Gets the ISO week of the year. First week is the week with the first Thursday of the year (i.e. of January) in it.

Returns

number

Call Signature

isoWeek(value): DateTime

Defined in: src/typings/dateTime.ts:131

Sets the ISO week of the year.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

isoWeekday()isoWeekday()

Call Signature

isoWeekday(): number

Defined in: src/typings/dateTime.ts:111

Gets the ISO day of the week with 1 being Monday and 7 being Sunday.

Returns

number

Call Signature

isoWeekday(value): DateTime

Defined in: src/typings/dateTime.ts:113

Sets the ISO day of the week with 1 being Monday and 7 being Sunday.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

isoWeeksInYear()isoWeeksInYear()

isoWeeksInYear(): number

Defined in: src/typings/dateTime.ts:137

Gets the number of weeks in the year, according to ISO weeks.

Returns

number

---

isoWeekYear()isoWeekYear()

Call Signature

isoWeekYear(): number

Defined in: src/typings/dateTime.ts:133

Gets the ISO week-year.

Returns

number

Call Signature

isoWeekYear(value): DateTime

Defined in: src/typings/dateTime.ts:135

Sets the ISO week-year.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

isSame()isSame()

isSame(input?, granularity?): boolean

Defined in: src/typings/dateTime.ts:85

Parameters

Parameter	Type
input?	DateTimeInput
granularity?	StartOfUnit

Returns

boolean

---

isValid()isValid()

isValid(): boolean

Defined in: src/typings/dateTime.ts:88

Returns

boolean

---

local()local()

local(keepLocalTime?): DateTime

Defined in: src/typings/dateTime.ts:89

Parameters

Parameter	Type
keepLocalTime?	boolean

Returns

DateTime

---

locale()locale()

Call Signature

locale(): string

Defined in: src/typings/dateTime.ts:90

Returns

string

Call Signature

locale(locale): DateTime

Defined in: src/typings/dateTime.ts:91

Parameters

Parameter	Type
locale	string

Returns

DateTime

---

millisecond()millisecond()

Call Signature

millisecond(): number

Defined in: src/typings/dateTime.ts:156

Returns

number

Call Signature

millisecond(value): DateTime

Defined in: src/typings/dateTime.ts:157

Parameters

Parameter	Type
value	number

Returns

DateTime

---

minute()minute()

Call Signature

minute(): number

Defined in: src/typings/dateTime.ts:152

Returns

number

Call Signature

minute(value): DateTime

Defined in: src/typings/dateTime.ts:153

Parameters

Parameter	Type
value	number

Returns

DateTime

---

month()month()

Call Signature

month(): number

Defined in: src/typings/dateTime.ts:142

Returns

number

Call Signature

month(value): DateTime

Defined in: src/typings/dateTime.ts:143

Parameters

Parameter	Type
value	number

Returns

DateTime

---

quarter()quarter()

Call Signature

quarter(): number

Defined in: src/typings/dateTime.ts:144

Returns

number

Call Signature

quarter(value): DateTime

Defined in: src/typings/dateTime.ts:145

Parameters

Parameter	Type
value	number

Returns

DateTime

---

second()second()

Call Signature

second(): number

Defined in: src/typings/dateTime.ts:154

Returns

number

Call Signature

second(value): DateTime

Defined in: src/typings/dateTime.ts:155

Parameters

Parameter	Type
value	number

Returns

DateTime

---

set()set()

Call Signature

set(unit, amount): DateTime

Defined in: src/typings/dateTime.ts:79

Parameters

Parameter	Type
unit	AllUnit
amount	number

Returns

DateTime

Call Signature

set(amount): DateTime

Defined in: src/typings/dateTime.ts:80

Parameters

Parameter	Type
amount	Partial

Returns

DateTime

---

startOf()startOf()

startOf(unitOfTime): DateTime

Defined in: src/typings/dateTime.ts:92

Parameters

Parameter	Type
unitOfTime	StartOfUnit

Returns

DateTime

---

subtract()subtract()

subtract(amount, unit?): DateTime

Defined in: src/typings/dateTime.ts:78

Parameters

Parameter	Type
amount	DurationInput
unit?	DurationUnit

Returns

DateTime

---

timeZone()timeZone()

Call Signature

timeZone(): string

Defined in: src/typings/dateTime.ts:102

Returns

string

Call Signature

timeZone(timeZone, keepLocalTime?): DateTime

Defined in: src/typings/dateTime.ts:103

Parameters

Parameter	Type
timeZone	string
keepLocalTime?	boolean

Returns

DateTime

---

toDate()toDate()

toDate(): Date

Defined in: src/typings/dateTime.ts:94

Returns

Date

---

toISOString()toISOString()

toISOString(keepOffset?): string

Defined in: src/typings/dateTime.ts:95

Parameters

Parameter	Type
keepOffset?	boolean

Returns

string

---

toJSON()toJSON()

toJSON(): null | string

Defined in: src/typings/dateTime.ts:96

Returns

null | string

---

unix()unix()

unix(): number

Defined in: src/typings/dateTime.ts:98

Returns

number

---

utc()utc()

utc(keepLocalTime?): DateTime

Defined in: src/typings/dateTime.ts:99

Parameters

Parameter	Type
keepLocalTime?	boolean

Returns

DateTime

---

utcOffset()utcOffset()

Call Signature

utcOffset(): number

Defined in: src/typings/dateTime.ts:100

Returns

number

Call Signature

utcOffset(offset, keepLocalTime?): DateTime

Defined in: src/typings/dateTime.ts:101

Parameters

Parameter	Type
offset	string | number
keepLocalTime?	boolean

Returns

DateTime

---

valueOf()valueOf()

valueOf(): number

Defined in: src/typings/dateTime.ts:97

Returns

number

---

week()week()

Call Signature

week(): number

Defined in: src/typings/dateTime.ts:119

Gets the week of the year according to the locale.

Returns

number

Call Signature

week(value): DateTime

Defined in: src/typings/dateTime.ts:121

Sets the week of the year according to the locale.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

weekday()weekday()

Call Signature

weekday(): number

Defined in: src/typings/dateTime.ts:115

Gets the day of the week according to the locale. 0 being first day of the week and 6 being last.

Returns

number

Call Signature

weekday(value): number

Defined in: src/typings/dateTime.ts:117

Sets the day of the week according to the locale. 0 being first day of the week and 6 being last.

Parameters

Parameter	Type
value	number

Returns

number

---

weeksInYear()weeksInYear()

weeksInYear(): number

Defined in: src/typings/dateTime.ts:127

Gets the number of weeks in the year according to locale

Returns

number

---

weekYear()weekYear()

Call Signature

weekYear(): number

Defined in: src/typings/dateTime.ts:123

Gets the week-year according to the locale.

Returns

number

Call Signature

weekYear(value): DateTime

Defined in: src/typings/dateTime.ts:125

Sets the week-year according to the locale.

Parameters

Parameter	Type
value	number

Returns

DateTime

---

year()year()

Call Signature

year(): number

Defined in: src/typings/dateTime.ts:146

Returns

number

Call Signature

year(value): DateTime

Defined in: src/typings/dateTime.ts:147

Parameters

Parameter	Type
value	number

Returns

DateTime