Temporal.PlainDate.prototype.until()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The until() method of Temporal.PlainDate instances returns a new Temporal.Duration object representing the duration from this date to another date (in a form convertible by Temporal.PlainDate.from()). The duration is positive if the other date is after this date, and negative if before.

This method does other - this. To do this - other, use the since() method.

Syntax

js
until(other)
until(other, options)

Parameters

other

A string, an object, or a Temporal.PlainDate instance representing a date to subtract this date from. It is converted to a Temporal.PlainDate object using the same algorithm as Temporal.PlainDate.from(). It must have the same calendar as this.

options Optional

The same options as since().

Return value

A new Temporal.Duration object representing the duration from this date until other. The duration is positive if other is after this date, and negative if before.

Exceptions

RangeError

Thrown in one of the following cases:

  • other has a different calendar than this.
  • Any of the options is invalid.

Examples

Using until()

js
const launch = Temporal.PlainDate.from("2035-01-01");
const now = Temporal.Now.plainDateISO();
const duration = now.until(launch);
console.log(`It will be ${duration.toLocaleString("en-US")} until the launch`);

For more examples, see since().

Specifications

Specification
Temporal proposal
# sec-temporal.plaindate.prototype.until

Browser compatibility

BCD tables only load in the browser

See also