Temporal.Duration.prototype.subtract()
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 subtract() method of Temporal.Duration instances returns a new Temporal.Duration object with the difference between this duration and a given duration. It is equivalent to adding the negated value of the other duration.
Syntax
subtract(other)
Parameters
other-
A string, an object, or a
Temporal.Durationinstance representing a duration to add to this duration. It is converted to aTemporal.Durationobject using the same algorithm asTemporal.Duration.from().
Return value
A new Temporal.Duration object representing the difference of this duration and other.
Exceptions
RangeError-
Thrown in one of the following cases:
- Either
thisorotheris a calendar duration (it has a non-zeroyears,months, orweeks), because calendar durations are ambiguous without a calendar and time reference. - The difference of
thisandotheroverflows the maximum or underflows the minimum representable duration, which is ±253 seconds.
- Either
Examples
Using subtract()
const d1 = Temporal.Duration.from({ hours: 1, minutes: 30 });
const d2 = Temporal.Duration.from({ hours: -1, minutes: -20 });
const d3 = d1.subtract(d2);
console.log(d3.toString()); // "PT2H50M"
For more examples and caveats, see the add() method.
Specifications
| Specification |
|---|
| Temporal # sec-temporal.duration.prototype.subtract |
Browser compatibility
Loading…