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: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The until() method of Temporal.Instant instances returns a new Temporal.Duration object representing the duration from this instant to another instant (in a form convertible by 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.Instantinstance representing an instant to subtract this instant from. It is converted to aTemporal.Instantobject using the same algorithm asTemporal.Instant.from(). optionsOptional-
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: "minute" });
console.log(`It will be ${duration.toLocaleString("en-US")} until the launch`);
For more examples, see since().
Specifications
| Specification |
|---|
| Temporal proposal # sec-temporal.instant.prototype.until |
Browser compatibility
BCD tables only load in the browser