goog.date.DateTime

Provided By	`goog.date.DateTime`
Extends	`goog.date.Date`
All Known Direct Subclasses	`goog.date.UtcDateTime`

Class representing a date and time. Defaults to current date and time if none is specified.

Implements most methods of the native js Date object and can be used interchangeably with it just as if goog.date.DateTime was a subclass of Date.

new DateTime( `opt_year`, `opt_month`, `opt_date`, `opt_hours`, `opt_minutes`, `opt_seconds`, `opt_milliseconds` )

Parameters

`opt_year`	`(number\|{getTime: ?}\|null)=`
	Four digit year or a date-like object. If not set, the created object will contain the date determined by goog.now().
`opt_month`	`number=`
	Month, 0 = Jan, 11 = Dec.
`opt_date`	`number=`
	Date of month, 1 - 31.
`opt_hours`	`number=`
	Hours, 0 - 23.
`opt_minutes`	`number=`
	Minutes, 0 - 59.
`opt_seconds`	`number=`
	Seconds, 0 - 61.
`opt_milliseconds`	`number=`
	Milliseconds, 0 - 999.

VIEW SOURCE

Instance Methods

Performs date calculation by adding the supplied interval to the date.

Overrides

goog.date.Date

Parameters

`interval`	`(goog.date.Interval\|null)`
	Date interval to add.

VIEW SOURCE

Overrides

goog.date.Date

Parameters

None.

Returns

goog.date.DateTime

A clone of the datetime object.

VIEW SOURCE

Tests whether given datetime is exactly equal to this DateTime.

Overrides

goog.date.Date

Parameters

`other`	`(goog.date.Date\|null)`
	The datetime to compare.

Returns

boolean

Whether the given datetime is exactly equal to this one.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The date of month.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The day of week, US style. 0 = Sun, 6 = Sat.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The day of year.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The first day of the week. 0 = Mon, 6 = Sun.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The cut off weekday used for week number calculations. 0 = Mon, 6 = Sun.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The four digit year of date.

VIEW SOURCE

Returns the hours part of the datetime.

Parameters

None.

Returns

number

An integer between 0 and 23, representing the hour.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

goog.date.weekDay

The day of week, ISO style. 0 = Mon, 6 = Sun.

VIEW SOURCE

Returns the milliseconds part of the datetime.

Parameters

None.

Returns

number

An integer between 0 and 999, representing the milliseconds.

VIEW SOURCE

Returns the minutes part of the datetime.

Parameters

None.

Returns

number

An integer between 0 and 59, representing the minutes.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

goog.date.month

The month of date, 0 = Jan, 11 = Dec.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The number of days for the selected month.

VIEW SOURCE

Returns the seconds part of the datetime.

Parameters

None.

Returns

number

An integer between 0 and 59, representing the seconds.

VIEW SOURCE

Returns the number of milliseconds since 1 January 1970 00:00:00.

Defined by

goog.date.Date

Parameters

None.

Returns

number

The number of milliseconds since 1 January 1970 00:00:00.

VIEW SOURCE

Returns timezone offset. The timezone offset is the delta in minutes between UTC and your local time. E.g., UTC+10 returns -600. Daylight savings time prevents this value from being constant.

Defined by

goog.date.Date

Parameters

None.

Returns

number

The timezone offset.

VIEW SOURCE

Returns timezone offset as a string. Returns offset in [+-]HH:mm format or Z for UTC.

Defined by

goog.date.Date

Parameters

None.

Returns

string

The timezone offset as a string.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The date of month according to universal time.

VIEW SOURCE

Returns the day of week according to universal time, US style.

Overrides

goog.date.Date

Parameters

None.

Returns

goog.date.weekDay

Day of week, 0 = Sun, 1 = Mon, 6 = Sat.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The four digit year of date according to universal time.

VIEW SOURCE

Returns the hours part of the datetime according to universal time.

Overrides

goog.date.Date

Parameters

None.

Returns

number

An integer between 0 and 23, representing the hour.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

goog.date.weekDay

The day of week according to universal time, ISO style. 0 = Mon, 6 = Sun.

VIEW SOURCE

Returns the milliseconds part of the datetime according to universal time.

Parameters

None.

Returns

number

An integer between 0 and 999, representing the milliseconds.

VIEW SOURCE

Returns the minutes part of the datetime according to universal time.

Overrides

goog.date.Date

Parameters

None.

Returns

number

An integer between 0 and 59, representing the minutes.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

goog.date.month

The month of date according to universal time, 0 = Jan, 11 = Dec.

VIEW SOURCE

Returns the seconds part of the datetime according to universal time.

Parameters

None.

Returns

number

An integer between 0 and 59, representing the seconds.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The day of week according to universal time and firstDayOfWeek setting.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The week number.

VIEW SOURCE

Defined by

goog.date.Date

Parameters

None.

Returns

number

The day of week according to firstDayOfWeek setting.

VIEW SOURCE

Alias for getFullYear.

Defined by

goog.date.Date

Parameters

None.

Returns

number

The four digit year of date.

See Also

#getFullYear

VIEW SOURCE

Returns year in “Week of Year” based calendars in which the year transition occurs on a week boundary.

Defined by

goog.date.Date

Parameters

None.

Returns

number

The four digit year in "Week of Year"

VIEW SOURCE

Parameters

None.

Returns

boolean

Whether the datetime is aligned to midnight.

VIEW SOURCE

Sets the date.

Defined by

goog.date.Date

Parameters

`date`	`(goog.date.Date\|null)`
	Date object to set date from.

VIEW SOURCE

Sets the day part of the date.

Defined by

goog.date.Date

Parameters

`date`	`number`
	The day part.

VIEW SOURCE

Sets the first day of week.

Defined by

goog.date.Date

Parameters

`day`	`number`
	0 = Mon, 6 = Sun.

VIEW SOURCE

Sets cut off weekday used for week number calculations. 0 = Mon, 6 = Sun.

Defined by

goog.date.Date

Parameters

`day`	`number`
	The cut off weekday.

VIEW SOURCE

Sets the year part of the date.

Defined by

goog.date.Date

Parameters

`year`	`number`
	Four digit year.

VIEW SOURCE

Sets the hours part of the datetime.

Parameters

`hours`	`number`
	An integer between 0 and 23, representing the hour.

VIEW SOURCE

Sets the milliseconds part of the datetime.

Parameters

`ms`	`number`
	Integer between 0 and 999, representing the milliseconds.

VIEW SOURCE

Sets the minutes part of the datetime.

Parameters

`minutes`	`number`
	Integer between 0 and 59, representing the minutes.

VIEW SOURCE

Sets the month part of the date.

TODO(nnaze): Update type to goog.date.month.

Defined by

goog.date.Date

Parameters

`month`	`number`
	The month, where 0 = Jan, 11 = Dec.

VIEW SOURCE

Sets the seconds part of the datetime.

Parameters

`seconds`	`number`
	Integer between 0 and 59, representing the seconds.

VIEW SOURCE

Sets the value of the date object as expressed in the number of milliseconds since 1 January 1970 00:00:00.

Defined by

goog.date.Date

Parameters

`ms`	`number`
	Number of milliseconds since 1 Jan 1970.

VIEW SOURCE

Sets the day part of the date according to universal time.

Defined by

goog.date.Date

Parameters

`date`	`number`
	The UTC date.

VIEW SOURCE

Sets the year part of the date according to universal time.

Defined by

goog.date.Date

Parameters

`year`	`number`
	Four digit year.

VIEW SOURCE

Sets the hours part of the datetime according to universal time.

Parameters

`hours`	`number`
	An integer between 0 and 23, representing the hour.

VIEW SOURCE

Sets the seconds part of the datetime according to universal time.

Parameters

`ms`	`number`
	Integer between 0 and 999, representing the milliseconds.

VIEW SOURCE

Sets the minutes part of the datetime according to universal time.

Parameters

`minutes`	`number`
	Integer between 0 and 59, representing the minutes.

VIEW SOURCE

Sets the month part of the date according to universal time.

Defined by

goog.date.Date

Parameters

`month`	`number`
	The month, where 0 = Jan, 11 = Dec.

VIEW SOURCE

Sets the seconds part of the datetime according to universal time.

Parameters

`seconds`	`number`
	Integer between 0 and 59, representing the seconds.

VIEW SOURCE

Alias for setFullYear.

Defined by

goog.date.Date

Parameters

`year`	`number`
	Four digit year.

Instance Properties

No information.

VIEW SOURCE

Static Functions

Parses an ISO 8601 string as a goog.date.DateTime.

Parameters

`formatted`	`string`
	ISO 8601 string to parse.

Returns

(goog.date.DateTime|null)

Parsed date or null if parse fails.

VIEW SOURCE

Creates a DateTime from a datetime string expressed in RFC 822 format.

Parameters

`formatted`	`string`
	A date or datetime expressed in RFC 822 format.

Returns

(goog.date.DateTime|null)

Parsed date or null if parse fails.

VIEW SOURCE

Parameters

`timestamp`	`number`
	Number of milliseconds since Epoch.

Returns

goog.date.DateTime

VIEW SOURCE

goog.date.DateTime

new DateTime( opt_year, opt_month, opt_date, opt_hours, opt_minutes, opt_seconds, opt_milliseconds )

Instance Methods

this.add( interval ) → void

this.clone() → goog.date.DateTime

this.equals( other ) → boolean

this.getDate() → number

this.getDay() → number

this.getDayOfYear() → number

this.getFirstDayOfWeek() → number

this.getFirstWeekCutOffDay() → number

this.getFullYear() → number

this.getHours() → number

this.getIsoWeekday() → goog.date.weekDay

this.getMilliseconds() → number

this.getMinutes() → number

this.getMonth() → goog.date.month

this.getNumberOfDaysInMonth() → number

this.getSeconds() → number

this.getTime() → number

this.getTimezoneOffset() → number

this.getTimezoneOffsetString() → string

this.getUTCDate() → number

this.getUTCDay() → goog.date.weekDay

this.getUTCFullYear() → number

this.getUTCHours() → number

this.getUTCIsoWeekday() → goog.date.weekDay

this.getUTCMilliseconds() → number

this.getUTCMinutes() → number

this.getUTCMonth() → goog.date.month

this.getUTCSeconds() → number

this.getUTCWeekday() → number

this.getWeekNumber() → number

this.getWeekday() → number

this.getYear() → number

this.getYearOfWeek() → number

this.isMidnight() → boolean

this.set( date ) → void

this.setDate( date ) → void

this.setFirstDayOfWeek( day ) → void

this.setFirstWeekCutOffDay( day ) → void

this.setFullYear( year ) → void

this.setHours( hours ) → void

this.setMilliseconds( ms ) → void

this.setMinutes( minutes ) → void

this.setMonth( month ) → void

this.setSeconds( seconds ) → void

this.setTime( ms ) → void

this.setUTCDate( date ) → void

this.setUTCFullYear( year ) → void

this.setUTCHours( hours ) → void

this.setUTCMilliseconds( ms ) → void

this.setUTCMinutes( minutes ) → void

this.setUTCMonth( month ) → void

this.setUTCSeconds( seconds ) → void

this.setYear( year ) → void

this.toIsoString( opt_verbose, opt_tz ) → string

this.toIsoTimeString( opt_showSeconds ) → string

this.toString() → string

this.toUTCIsoString( opt_verbose, opt_tz ) → string

this.toUTCRfc3339String() → string

this.toUsTimeString( opt_padHours, opt_showAmPm, opt_omitZeroMinutes ) → string

this.toXmlDateTime( opt_timezone ) → string

this.valueOf() → number

Instance Properties

this.date → Date

Static Functions

DateTime.fromIsoString( formatted ) → (goog.date.DateTime|null)

DateTime.fromRfc822String( formatted ) → (goog.date.DateTime|null)

DateTime.fromTimestamp( timestamp ) → goog.date.DateTime

new DateTime( `opt_year`, `opt_month`, `opt_date`, `opt_hours`, `opt_minutes`, `opt_seconds`, `opt_milliseconds` )

`this.`add( `interval` ) `→` `void`

`this.`clone() `→` `goog.date.DateTime`

`this.`equals( `other` ) `→` `boolean`

`this.`getDate() `→` `number`

`this.`getDay() `→` `number`

`this.`getDayOfYear() `→` `number`

`this.`getFirstDayOfWeek() `→` `number`

`this.`getFirstWeekCutOffDay() `→` `number`

`this.`getFullYear() `→` `number`

`this.`getHours() `→` `number`

`this.`getIsoWeekday() `→` `goog.date.weekDay`

`this.`getMilliseconds() `→` `number`

`this.`getMinutes() `→` `number`

`this.`getMonth() `→` `goog.date.month`

`this.`getNumberOfDaysInMonth() `→` `number`

`this.`getSeconds() `→` `number`

`this.`getTime() `→` `number`

`this.`getTimezoneOffset() `→` `number`

`this.`getTimezoneOffsetString() `→` `string`

`this.`getUTCDate() `→` `number`

`this.`getUTCDay() `→` `goog.date.weekDay`

`this.`getUTCFullYear() `→` `number`

`this.`getUTCHours() `→` `number`

`this.`getUTCIsoWeekday() `→` `goog.date.weekDay`

`this.`getUTCMilliseconds() `→` `number`

`this.`getUTCMinutes() `→` `number`

`this.`getUTCMonth() `→` `goog.date.month`

`this.`getUTCSeconds() `→` `number`

`this.`getUTCWeekday() `→` `number`

`this.`getWeekNumber() `→` `number`

`this.`getWeekday() `→` `number`

`this.`getYear() `→` `number`

`this.`getYearOfWeek() `→` `number`

`this.`isMidnight() `→` `boolean`

`this.`set( `date` ) `→` `void`

`this.`setDate( `date` ) `→` `void`

`this.`setFirstDayOfWeek( `day` ) `→` `void`

`this.`setFirstWeekCutOffDay( `day` ) `→` `void`

`this.`setFullYear( `year` ) `→` `void`

`this.`setHours( `hours` ) `→` `void`

`this.`setMilliseconds( `ms` ) `→` `void`

`this.`setMinutes( `minutes` ) `→` `void`

`this.`setMonth( `month` ) `→` `void`

`this.`setSeconds( `seconds` ) `→` `void`

`this.`setTime( `ms` ) `→` `void`

`this.`setUTCDate( `date` ) `→` `void`

`this.`setUTCFullYear( `year` ) `→` `void`

`this.`setUTCHours( `hours` ) `→` `void`

`this.`setUTCMilliseconds( `ms` ) `→` `void`

`this.`setUTCMinutes( `minutes` ) `→` `void`

`this.`setUTCMonth( `month` ) `→` `void`

`this.`setUTCSeconds( `seconds` ) `→` `void`

`this.`setYear( `year` ) `→` `void`

`this.`toIsoString( `opt_verbose`, `opt_tz` ) `→` `string`

`this.`toIsoTimeString( `opt_showSeconds` ) `→` `string`

`this.`toString() `→` `string`

`this.`toUTCIsoString( `opt_verbose`, `opt_tz` ) `→` `string`

`this.`toUTCRfc3339String() `→` `string`

`this.`toUsTimeString( `opt_padHours`, `opt_showAmPm`, `opt_omitZeroMinutes` ) `→` `string`

`this.`toXmlDateTime( `opt_timezone` ) `→` `string`

`this.`valueOf() `→` `number`

`this.`date `→` `Date`

DateTime.fromIsoString( `formatted` ) `→` `(goog.date.DateTime|null)`

DateTime.fromRfc822String( `formatted` ) `→` `(goog.date.DateTime|null)`

DateTime.fromTimestamp( `timestamp` ) `→` `goog.date.DateTime`