Temporal.PlainTime.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.PlainTime instances returns a new Temporal.Duration object representing the duration from this time to another time (in a form convertible by Temporal.PlainTime.from()). The duration is positive if the other time is after this 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
Temporal.PlainTimeinstance representing a time to subtract this time from. It is converted to aTemporal.PlainTimeobject using the same algorithm asTemporal.PlainTime.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 time until other. The duration is positive if other is after this time, and negative if before.
Exceptions
RangeError-
Thrown if any of the options is invalid.
Examples
Using until()
const lunchTime = Temporal.PlainTime.from("12:30:00");
const now = Temporal.Now.plainTimeISO();
const duration = now.until(lunchTime);
console.log(`It will be ${duration.toLocaleString("en-US")} until lunch`);
// Example output: "It will be 3 hr, 42 min, 21 sec, 343 ms, 131 μs, 718 ns until lunch"
For more examples, see since().
Specifications
| Specification |
|---|
| Temporal # sec-temporal.plaintime.prototype.until |
Browser compatibility
Loading…