Class DateTime

Hierarchy

DateTime

Implements

Index

Constructors

constructor

new DateTime(): DateTime
Returns DateTime
- Defined in DateTime.ts:27
new DateTime(dateString: string, kind?: DateTimeKind): DateTime
Parameters
- dateString: string
- Optional kind: DateTimeKind
Returns DateTime
- Defined in DateTime.ts:29
new DateTime(milliseconds: number, kind?: DateTimeKind): DateTime
Parameters
- milliseconds: number
- Optional kind: DateTimeKind
Returns DateTime
- Defined in DateTime.ts:31
new DateTime(source: Date, kind?: DateTimeKind): DateTime
Parameters
- source: Date
- Optional kind: DateTimeKind
Returns DateTime
- Defined in DateTime.ts:33
new DateTime(source: DateTime, kind?: DateTimeKind): DateTime
Parameters
- source: DateTime
- Optional kind: DateTimeKind
Returns DateTime
- Defined in DateTime.ts:35

Accessors

calendar

get calendar(): CalendarDate
Returns CalendarDate
- Defined in DateTime.ts:112

calendarMonth

get calendarMonth(): number
Returns the month number (1-12).

Returns

Returns number
- Defined in DateTime.ts:107

date

get date(): DateTime
Returns a DateTime object for 00:00 of this date.

Returns DateTime
- Defined in DateTime.ts:151

day

get day(): number
Returns the day of the month. An integer between 1 and 31.

Returns

Returns number
Implementation of CalendarDate.day
- Defined in DateTime.ts:125

dayIndex

get dayIndex(): number
Returns the day of the month indexed starting at zero.

Returns

Returns number
- Defined in DateTime.ts:134

dayOfWeek

get dayOfWeek(): DayOfWeek
Returns the zero indexed day of the week. (Sunday == 0)

Returns

Returns DayOfWeek
- Defined in DateTime.ts:143

kind

get kind(): DateTimeKind
Returns DateTimeKind
- Defined in DateTime.ts:84

month

get month(): Month
Returns the Gregorian Month (zero indexed).

Returns

Returns Month
Implementation of CalendarDate.month
- Defined in DateTime.ts:98

timeOfDay

get timeOfDay(): ClockTime
Returns the time of day represented by a ClockTime object.

Returns

Returns ClockTime
- Defined in DateTime.ts:168

year

get year(): number
Returns number
Implementation of CalendarDate.year
- Defined in DateTime.ts:89

`Static` now

get now(): DateTime
Returns the now local time.

Returns

Returns DateTime
- Defined in DateTime.ts:60

`Static` today

get today(): DateTime
The date component for now.

Returns

Returns DateTime
- Defined in DateTime.ts:69

`Static` tomorrow

get tomorrow(): DateTime
Midnight tomorrow.

Returns

Returns DateTime
- Defined in DateTime.ts:78

Methods

add

add(time: TimeQuantity): DateTime
Receives an TimeQuantity value and adds based on the total milliseconds.

Returns
Parameters
- time: TimeQuantity
Returns DateTime
- Defined in DateTime.ts:327

addDays

addDays(days: number): DateTime
Parameters
- days: number
Returns DateTime
- Defined in DateTime.ts:300

addHours

addHours(hours: number): DateTime
Parameters
- hours: number
Returns DateTime
- Defined in DateTime.ts:294

addMilliseconds

addMilliseconds(ms: number): DateTime
Parameters
- ms: number
Returns DateTime
- Defined in DateTime.ts:276

addMinutes

addMinutes(minutes: number): DateTime
Parameters
- minutes: number
Returns DateTime
- Defined in DateTime.ts:288

addMonths

addMonths(months: number): DateTime
Parameters
- months: number
Returns DateTime
- Defined in DateTime.ts:306

addSeconds

addSeconds(seconds: number): DateTime
Parameters
- seconds: number
Returns DateTime
- Defined in DateTime.ts:282

addYears

addYears(years: number): DateTime
Parameters
- years: number
Returns DateTime
- Defined in DateTime.ts:314

compareTo

compareTo(other: Date | JsDateConvertible): number
Parameters
- other: Date | JsDateConvertible
Returns number
- Defined in DateTime.ts:429

equals

equals(other: Date): boolean
Compares a JS Date with the current instance. Does not evaluate the kind.

Returns
Parameters
- other: Date
Returns boolean
- Defined in DateTime.ts:390
equals(other: JsDateConvertible, strict?: boolean): boolean
Compares another JsDateConvertible object and returns true if they or their value are equal.

Returns
Parameters
- other: JsDateConvertible
  
  The other JsDateConvertible object.
- Optional strict: boolean
  
  When strict is true, the 'kind' also must match.
Returns boolean
- Defined in DateTime.ts:398

equivalent

equivalent(other: Date | JsDateConvertible): boolean
Returns true if the value is the same UTC time.

Returns
Parameters
- other: Date | JsDateConvertible
Returns boolean
- Defined in DateTime.ts:454

subtract

subtract(time: TimeQuantity): DateTime
Receives an TimeQuantity value and subtracts based on the total milliseconds.

Returns
Parameters
- time: TimeQuantity
Returns DateTime
- Defined in DateTime.ts:337

timePassedSince

timePassedSince(previous: Date | DateTime): TimeSpan
Returns a TimeSpan representing the amount of time between two dates.

Returns
Parameters
- previous: Date | DateTime
Returns TimeSpan
- Defined in DateTime.ts:347

toJsDate

toJsDate(): Date
Returns Date
Implementation of JsDateConvertible.toJsDate
- Defined in DateTime.ts:271

toTimeStamp

toTimeStamp(): TimeStamp
Returns a readonly object which contains all the date and time components.

Returns TimeStamp
- Defined in DateTime.ts:355

toUniversalTime

toUniversalTime(): DateTime
Returns a UTC version of this date if its kind is local.

Returns

Returns DateTime
- Defined in DateTime.ts:364

`Static` between

between(first: Date | DateTime, last: Date | DateTime): TimeSpan
Measures the difference between two dates as a TimeSpan.
Parameters
- first: Date | DateTime
- last: Date | DateTime
Returns TimeSpan
- Defined in DateTime.ts:189

`Static` daysInMonth

daysInMonth(year: number, month: Month): number
Returns the number of days for the specific year and month.

Returns
Parameters
- year: number
- month: Month
Returns number
- Defined in DateTime.ts:215

`Static` from

from(calendarDate: CalendarDate): DateTime
Parameters
- calendarDate: CalendarDate
Returns DateTime
- Defined in DateTime.ts:221
from(year: number, month: Month, day: number): DateTime
Parameters
- year: number
- month: Month
- day: number
Returns DateTime
- Defined in DateTime.ts:223

`Static` fromCalendarDate

fromCalendarDate(calendarDate: CalendarDate): DateTime
Parameters
- calendarDate: CalendarDate
Returns DateTime
- Defined in DateTime.ts:246
fromCalendarDate(year: number, month: number, day: number): DateTime
Parameters
- year: number
- month: number
- day: number
Returns DateTime
- Defined in DateTime.ts:248

`Static` isLeapYear

isLeapYear(year: number): boolean
Calculates if the given year is a leap year using the formula: ((year % 4 == 0) && (year % 100 != 0)) || (year % 400 == 0)

Returns
Parameters
- year: number
Returns boolean
- Defined in DateTime.ts:204

Class DateTime

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns DateTime

Parameters

dateString: string

Optional kind: DateTimeKind

Returns DateTime

Parameters

milliseconds: number

Optional kind: DateTimeKind

Returns DateTime

Parameters

source: Date

Optional kind: DateTimeKind

Returns DateTime

Parameters

source: DateTime

Optional kind: DateTimeKind

Returns DateTime

Accessors

calendar

Returns CalendarDate

calendarMonth

Returns

Returns number

date

Returns DateTime

day

Returns

Returns number

dayIndex

Returns

Returns number

dayOfWeek

Returns

Returns DayOfWeek

kind

Returns DateTimeKind

month

Returns

Returns Month

timeOfDay

Returns

Returns ClockTime

year

Returns number

Static now

Returns

Returns DateTime

Static today

Returns

Returns DateTime

Static tomorrow

Returns

Returns DateTime

Methods

add

Returns

Parameters

time: TimeQuantity

Returns DateTime

addDays

Parameters

days: number

Returns DateTime

addHours

Parameters

hours: number

Returns DateTime

addMilliseconds

Parameters

ms: number

Returns DateTime

`Optional` kind: DateTimeKind

`Optional` kind: DateTimeKind

`Optional` kind: DateTimeKind

`Optional` kind: DateTimeKind

`Static` now

`Static` today

`Static` tomorrow

`Optional` strict: boolean

`Static` between

`Static` daysInMonth

`Static` from