Temporal.ZonedDateTime.prototype.subtract()

The subtract() method of {{jsxref("Temporal.ZonedDateTime")}} instances returns a new Temporal.ZonedDateTime object representing this date-time moved backward by a given duration (in a form convertible by {{jsxref("Temporal/Duration/from", "Temporal.Duration.from()")}}).

If you want to subtract two date-times and get a duration, use {{jsxref("Temporal/ZonedDateTime/since", "since()")}} or {{jsxref("Temporal/ZonedDateTime/until", "until()")}} instead.

Syntax#

subtract(duration)
subtract(duration, options)

Parameters#

• duration
• : A string, an object, or a {{jsxref("Temporal.Duration")}} instance representing a duration to subtract from this date-time. It is converted to a Temporal.Duration object using the same algorithm as {{jsxref("Temporal/Duration/from", "Temporal.Duration.from()")}}.
• options {{optional_inline}}
• : An object containing the following property:
  • overflow {{optional_inline}}
  • : A string specifying the behavior when a date component is out of range. Possible values are:
    • "constrain" (default)
    • : The date component is clamped to the valid range.
    • "reject"
    • : A {{jsxref("RangeError")}} is thrown if the date component is out of range.

Return value#

A new Temporal.ZonedDateTime object representing the date-time specified by the original ZonedDateTime, minus the duration.

Exceptions#

• {{jsxref("RangeError")}}
• : Thrown if the result is not in the representable range, which is ±10⁸ days, or about ±273,972.6 years, from the Unix epoch.

Description#

Subtracting a duration is equivalent to adding its negation, so all the same considerations apply.

Examples#

Subtracting a duration#

const start = Temporal.ZonedDateTime.from(
  "2021-01-01T12:34:56-05:00[America/New_York]",
);
const end = start.subtract({
  years: 1,
  months: 2,
  weeks: 3,
  days: 4,
  hours: 5,
  minutes: 6,
  seconds: 7,
  milliseconds: 8,
});
console.log(end.toString()); // 2019-10-07T07:28:48.992-04:00[America/New_York]

Specifications#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

• {{jsxref("Temporal.ZonedDateTime")}}
• {{jsxref("Temporal.Duration")}}
• {{jsxref("Temporal/ZonedDateTime/add", "Temporal.ZonedDateTime.prototype.add()")}}
• {{jsxref("Temporal/ZonedDateTime/since", "Temporal.ZonedDateTime.prototype.since()")}}
• {{jsxref("Temporal/ZonedDateTime/until", "Temporal.ZonedDateTime.prototype.until()")}}