The until() method of Temporal.PlainYearMonth instances returns a new Temporal.Duration object representing the duration from this year-month to another year-month (in a form convertible by Temporal/PlainYearMonth/from). The duration is positive if the other month is after this month, and negative if before.
This method does other - this. To do this - other, use the Temporal/PlainYearMonth/since method.
Syntax
until(other)
until(other, options)
Parameters
other- : A string, an object, or a Temporal.PlainYearMonth instance representing a year-month to subtract this year-month from. It is converted to a
Temporal.PlainYearMonthobject using the same algorithm as Temporal/PlainYearMonth/from. It must have the same calendar asthis.
- : A string, an object, or a Temporal.PlainYearMonth instance representing a year-month to subtract this year-month 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 year-month until other. The duration is positive if other is after this year-month, 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()
const launch = Temporal.PlainYearMonth.from("2035-01");
const now = Temporal.Now.plainDateISO().toPlainYearMonth();
const duration = now.until(launch);
console.log(`It will be ${duration.toLocaleString("en-US")} until the launch`);
For more examples, see since().
Specifications
Browser compatibility
See also
- Temporal.PlainYearMonth
- Temporal.Duration
- Temporal/PlainYearMonth/add
- Temporal/PlainYearMonth/subtract
- Temporal/PlainYearMonth/since
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
