Class DateTime

Tick DateTime.

Hierarchy

DateTime

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DateTime(): DateTime
new DateTime(opts: DateTimeCreationOptions): DateTime
new DateTime(year: number, month: number, day?: number, hour?: number, minute?: number, second?: number, ms?: number, opts?: DateTimeCreationOptions): DateTime
new DateTime(opts: DateTimeCreationOptions, year: number, month: number, day?: number, hour?: number, minute?: number, second?: number, ms?: number): DateTime
new DateTime(timestamp: number, opts?: DateTimeCreationOptions): DateTime

- Defined in main/date-time.ts:66
Creates a new DateTime object.

Returns DateTime
- Defined in main/date-time.ts:67
Parameters
- opts: DateTimeCreationOptions
Returns DateTime
- Defined in main/date-time.ts:68
Parameters
- year: number
- month: number
- Optional day: number
- Optional hour: number
- Optional minute: number
- Optional second: number
- Optional ms: number
- Optional opts: DateTimeCreationOptions
Returns DateTime
- Defined in main/date-time.ts:69
Parameters
- opts: DateTimeCreationOptions
- year: number
- month: number
- Optional day: number
- Optional hour: number
- Optional minute: number
- Optional second: number
- Optional ms: number
Returns DateTime
- Defined in main/date-time.ts:70
Parameters
- timestamp: number
- Optional opts: DateTimeCreationOptions
Returns DateTime

Properties

Private #c

Private #l

Private #ts

#ts: number

Private #units

#units: DateTimeUnits

Private #z

#z: Zone

Accessors

calendar

get calendar(): Calendar

- Defined in main/date-time.ts:328
Gets the calendar of this DateTime

Returns Calendar

config

get config(): DateTimeConfiguration

- Defined in main/date-time.ts:237
Returns a clone of the configurations of this object (calandar, zone and locale).

Returns DateTimeConfiguration

date

get date(): DateTime

- Defined in main/date-time.ts:356
Clones this DateTime with "time units" (hour, minute, second, ms) set to zero.

Returns DateTime

day

get day(): number

- Defined in main/date-time.ts:183
Gets the day of the month (1 to 31).

Returns number

hour

get hour(): number

- Defined in main/date-time.ts:191
Gets the hour of the day (0 to 23).

Returns number

locale

get locale(): Locale

- Defined in main/date-time.ts:267
Gets the locale of a DateTime.

Returns Locale

minute

get minute(): number

- Defined in main/date-time.ts:199
Gets the minute of the hour (0 to 59).

Returns number

month

get month(): number

- Defined in main/date-time.ts:175
Gets the month (1-12).

Returns number

ms

get ms(): number

- Defined in main/date-time.ts:215
Gets the millisecond of the second (0 to 999).

Returns number

second

get second(): number

- Defined in main/date-time.ts:207
Gets the second of the minute (0 to 59).

Returns number

ts

get ts(): number

- Defined in main/date-time.ts:225
Gets the timestamp of this object.

description
This value is usually the number of milliseconds since January 1, 1970 (EPOCH) and it can be a positive or negetive number (it depends on the implementation of the Calendar).

Returns number

year

get year(): number

- Defined in main/date-time.ts:167
Gets the year.

Returns number

zone

get zone(): Zone

- Defined in main/date-time.ts:285
Returns the zone of this DateTime object

Returns Zone

Methods

add

add(units: DateTimeUnits): DateTime

- Defined in main/date-time.ts:248
Adds a period of time to this DateTime and returns the resulting DateTime.

Parameters
- units: DateTimeUnits
  
  DateTimeUnits
Returns DateTime

clone

clone(newUnits?: DateTimeUnits): DateTime

- Defined in main/date-time.ts:338
Clones this DateTime with overwriten new unit values.

Parameters
- Optional newUnits: DateTimeUnits
Returns DateTime

subtract

subtract(units: DateTimeUnits): DateTime

- Defined in main/date-time.ts:257
Subtracts a period of time from this DateTime and returns the resulting DateTime.

Parameters
- units: DateTimeUnits
  
  DateTimeUnits
Returns DateTime

to

to(calendar: CalendarSpecifier): DateTime

- Defined in main/date-time.ts:320
Returns a new DateTime equivalent with this DateTime but with a different Calendar

Parameters
- calendar: CalendarSpecifier
  
  CalendarSpecifier
Returns DateTime

toLocal

toLocal(): DateTime

- Defined in main/date-time.ts:301
Returns a new DateTime equivalent with this DateTime but with local time-zone

Returns DateTime

toLocale

toLocale(locale: LocaleSpecifier): DateTime

- Defined in main/date-time.ts:275
Returns a new DateTime equivalent with this DateTime but with a different Locale

Parameters
- locale: LocaleSpecifier
Returns DateTime

toObject

toObject(): DateTimeUnits

- Defined in main/date-time.ts:365
Returns the units of this DateTime object.

Returns DateTimeUnits

toUtc

toUtc(): DateTime

- Defined in main/date-time.ts:293
Returns a new DateTime equivalent with this DateTime but with UTC as time-zone

Returns DateTime

toZone

toZone(zone: ZoneSpecifier): DateTime

- Defined in main/date-time.ts:309
Returns a new DateTime equivalent with this DateTime but with a different Zone

Parameters
- zone: ZoneSpecifier
Returns DateTime

Generated using TypeDoc