Temporal.Instant.prototype.until()

The until() method of Instant instances returns a new 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 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 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

Browser compatibility

See also

• Instant
• Duration
• Temporal.Instant.prototype.add()
• Temporal.Instant.prototype.subtract()
• Temporal.Instant.prototype.since()