Temporal.Duration.prototype.subtract()

The subtract() method of 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 Duration instance representing a duration to add to this duration. It is converted to a Temporal.Duration object using the same algorithm as Temporal.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 this or other is a calendar duration (it has a non-zero years, months, or weeks), because calendar durations are ambiguous without a calendar and time reference.
    • The difference of this and other overflows the maximum or underflows the minimum representable duration, which is ±2⁵³ seconds.

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

Browser compatibility

See also

• Duration
• Temporal.Duration.prototype.add()
• Temporal.Duration.prototype.negated()