Skip to main content
Temporal - Web documentation

Classes

c
Temporal.Instant

A Temporal.Instant is an exact point in time, with a precision in nanoseconds. No time zone or calendar information is present. Therefore, Temporal.Instant has no concept of days, months, or even hours.

c
Temporal.PlainDate

A Temporal.PlainDate represents a calendar date. "Calendar date" refers to the concept of a date as expressed in everyday usage, independent of any time zone. For example, it could be used to represent an event on a calendar which happens during the whole day no matter which time zone it's happening in.

c
Temporal.PlainDateTime

A Temporal.PlainDateTime represents a calendar date and wall-clock time, with a precision in nanoseconds, and without any time zone. Of the Temporal classes carrying human-readable time information, it is the most general and complete one. Temporal.PlainDate, Temporal.PlainTime, Temporal.PlainYearMonth, and Temporal.PlainMonthDay all carry less information and should be used when complete information is not required.

c
Temporal.PlainMonthDay

A Temporal.PlainMonthDay represents a particular day on the calendar, but without a year. For example, it could be used to represent a yearly recurring event, like "Bastille Day is on the 14th of July."

c
Temporal.PlainTime

A Temporal.PlainTime represents a wall-clock time, with a precision in nanoseconds, and without any time zone. "Wall-clock time" refers to the concept of a time as expressed in everyday usage — the time that you read off the clock on the wall. For example, it could be used to represent an event that happens daily at a certain time, no matter what time zone.

c
Temporal.PlainYearMonth

A Temporal.PlainYearMonth represents a particular month on the calendar. For example, it could be used to represent a particular instance of a monthly recurring event, like "the June 2019 meeting".

Interfaces

I
Temporal.DifferenceOptions

Options to control the result of until() and since() methods in Temporal types.

I
Temporal.DurationArithmeticOptions

Options to control behavior of Duration.compare()

Namespaces

Type Aliases

T
Temporal.ArithmeticOptions

Options for arithmetic operations like add() and subtract()

T
Temporal.AssignmentOptions

Options for assigning fields using with() or entire objects with from().

T
Temporal.CalendarLike

Any of these types can be passed to Temporal methods instead of a calendar ID.

T
Temporal.CalendarTypeToStringOptions
No documentation available
T
Temporal.ComparisonResult
No documentation available
T
Temporal.DateTimeUnit
No documentation available
T
Temporal.DateUnit
No documentation available
T
Temporal.DurationOptions

Options for assigning fields using Duration.prototype.with() or entire objects with Duration.from(), and for arithmetic with Duration.prototype.add() and Duration.prototype.subtract().

T
Temporal.DurationRoundTo

The round method of the Temporal.Duration accepts one required parameter. If a string is provided, the resulting Temporal.Duration object will be rounded to that unit. If an object is provided, the smallestUnit and/or largestUnit property is required, while other properties are optional. A string parameter is treated the same as an object whose smallestUnit property value is that string.

T
Temporal.DurationTotalOf

Options to control behavior of Duration.prototype.total()

T
Temporal.InstantToStringOptions
No documentation available
T
Temporal.LargestUnit
No documentation available
T
Temporal.OffsetDisambiguationOptions
No documentation available
T
Temporal.PluralUnit

When the name of a unit is provided to a Temporal API as a string, it is usually singular, e.g. 'day' or 'hour'. But plural unit names like 'days' or 'hours' are also accepted.

T
Temporal.RoundingMode
No documentation available
T
Temporal.RoundTo

round methods take one required parameter. If a string is provided, the resulting Temporal.Duration object will be rounded to that unit. If an object is provided, its smallestUnit property is required while other properties are optional. A string is treated the same as an object whose smallestUnit property value is that string.

T
Temporal.ShowCalendarOption
No documentation available
T
Temporal.SmallestUnit
No documentation available
T
Temporal.TimeUnit
No documentation available
T
Temporal.TimeZoneLike

Any of these types can be passed to Temporal methods instead of a time zone ID.

T
Temporal.ToInstantOptions

Options for conversions of Temporal.PlainDateTime to Temporal.Instant

T
Temporal.ToStringPrecisionOptions

Options for outputting precision in toString() on types with seconds

T
Temporal.TotalUnit
No documentation available
T
Temporal.TransitionDirection

Options to control behaviour of ZonedDateTime.prototype.getTimeZoneTransition()

T
Temporal.ZonedDateTimeAssignmentOptions
No documentation available
T
Temporal.ZonedDateTimeToStringOptions
No documentation available

Variables

v
Temporal.Now

The Temporal.Now object has several methods which give information about the current date, time, and time zone.