Temporal.PlainDateTime.prototype.until()

The until() method of PlainDateTime instances returns a new Duration object representing the duration from this date-time to another date-time (in a form convertible by Temporal.PlainDateTime.from()). The duration is positive if the other date-time is after this date-time, 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, an object, or a PlainDateTime instance representing a date-time to subtract this date-time from. It is converted to a Temporal.PlainDateTime object using the same algorithm as Temporal.PlainDateTime.from(). It must have the same calendar as this.
• options Optional
  • : The same options as since().

Return value

A new Duration object representing the duration from this date-time until other. The duration is positive if other is after this date-time, 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()

let nextBilling = Temporal.PlainDateTime.from({
  year: Temporal.Now.plainDateISO().year,
  month: 4,
  day: 1,
});
const now = Temporal.Now.plainDateTimeISO().round("second");
if (Temporal.PlainDateTime.compare(nextBilling, now) < 0) {
  nextBilling = nextBilling.add({ years: 1 });
}
const duration = now.until(nextBilling);
console.log(`${duration.toLocaleString("en-US")} until next billing`);

For more examples, see since().

Specifications

Browser compatibility

See also

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