The until() method of Temporal.PlainDateTime instances returns a new Temporal.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 Temporal/PlainDateTime/since method.
Syntax
until(other)
until(other, options)
Parameters
other- : A string, an object, or a Temporal.PlainDateTime instance representing a date-time to subtract this date-time from. It is converted to a
Temporal.PlainDateTimeobject using the same algorithm as Temporal/PlainDateTime/from. It must have the same calendar asthis.
- : A string, an object, or a Temporal.PlainDateTime instance representing a date-time to subtract this date-time from. It is converted to a
options- : The same options as
since().
- : The same options as
Return value
A new Temporal.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:
otherhas a different calendar thanthis.- Any of the options is invalid.
- : Thrown in one of the following cases:
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
- Temporal.PlainDateTime
- Temporal.Duration
- Temporal/PlainDateTime/add
- Temporal/PlainDateTime/subtract
- Temporal/PlainDateTime/since
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
