Temporal.PlainTime.prototype.since()
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 since() method of Temporal.PlainTime instances returns a new Temporal.Duration object representing the duration from another time (in a form convertible by Temporal.PlainTime.from()) to this time. The duration is positive if the other time is before this time, and negative if after.
This method does this - other. To do other - this, use the until() method.
Syntax
since(other)
since(other, options)
Parameters
other-
A string, an object, or a
Temporal.PlainTimeinstance representing a time to subtract from this time. It is converted to aTemporal.PlainTimeobject using the same algorithm asTemporal.PlainTime.from(). optionsOptional-
An object containing the options for
Temporal.Duration.prototype.round(), which includeslargestUnit,roundingIncrement,roundingMode, andsmallestUnit.largestUnitandsmallestUnitonly accept the units:"hours","minutes","seconds","milliseconds","microseconds","nanoseconds", or their singular forms. ForlargestUnit, the default value"auto"means"hours". ForsmallestUnit, the default value is"nanoseconds".
Return value
A new Temporal.Duration object representing the duration since other to this time. The duration is positive if other is before this time, and negative if after.
Exceptions
RangeError-
Thrown if any of the options is invalid.
Examples
Using since()
const lunchTime = Temporal.PlainTime.from("12:30:00");
const now = Temporal.Now.plainTimeISO();
const duration = now.since(lunchTime);
console.log(`You had lunch ${duration.toLocaleString("en-US")} ago`);
// Example output: "You had lunch 3 hr, 42 min, 21 sec, 343 ms, 131 μs, 718 ns ago"
const duration2 = now.since(lunchTime, { smallestUnit: "minutes" });
console.log(`You had lunch ${duration2.toLocaleString("en-US")} ago`);
// Example output: "You had lunch 3 hr, 42 min ago"
const duration3 = now.since(lunchTime, {
largestUnit: "minutes",
smallestUnit: "minutes",
});
console.log(`You had lunch ${duration3.toLocaleString("en-US")} ago`);
// Example output: "You had lunch 222 min ago"
Rounding the result
By default the fractional part of the smallestUnit is truncated. You can round it up using the roundingIncrement and roundingMode options.
const time1 = Temporal.PlainTime.from("12:30:00");
const time2 = Temporal.PlainTime.from("12:30:01");
const duration = time2.since(time1, {
smallestUnit: "seconds",
roundingIncrement: 15,
roundingMode: "ceil",
});
console.log(duration.toString()); // "PT15S"
Specifications
| Specification |
|---|
| Temporal # sec-temporal.plaintime.prototype.since |
Browser compatibility
Loading…