Temporal.Instant.prototype.until()

Limited availability

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

experimental technology
Check the Browser compatibility table carefully before using this in production.

The until() method of Temporal.Instant.from()). The duration is positive if the other instant is after this instant, and negative if before.

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

Syntax

until(other)
until(other, options)

Parameters

other: A string or a Temporal.Instant.from().
options Optional: The same options as since().

Return value

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

Exceptions

RangeError: Thrown if any of the options is invalid.

Examples

Using until()

const launch = Temporal.Instant.fromEpochMilliseconds(2051222400000);
const now = Temporal.Now.instant();
const duration = now.until(launch, { smallestUnit: "minutes" });
console.log(`It will be ${duration.toLocaleString("en-US")} until the launch`);

For more examples, see since().

Specifications

Specification
Temporal # sec-temporal.instant.prototype.until