Temporal.PlainYearMonth.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.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 since() method.
Syntax
until(other)
until(other, options)
Parameters
other-
A string, an object, or a
Temporal.PlainYearMonthinstance representing a year-month to subtract this year-month from. It is converted to aTemporal.PlainYearMonthobject using the same algorithm asTemporal.PlainYearMonth.from(). It must have the same calendar asthis. optionsOptional-
The same options as
since().
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.
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
| Specification |
|---|
| Temporal # sec-temporal.plainyearmonth.prototype.until |
Browser compatibility
Loading…