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

js
until(other)
until(other, options)

Parameters

other

A string or a Temporal.Instant instance representing an instant to subtract this instant from. It is converted to a Temporal.Instant object using the same algorithm as 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()

js
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 proposal
# sec-temporal.instant.prototype.until

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
until
Experimental

Legend

Tip: you can click/tap on a cell for more information.

In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.
User must explicitly enable this feature.

See also