The subtract() method of Temporal.ZonedDateTime instances returns a new Temporal.ZonedDateTime object representing this date-time moved backward by a given duration (in a form convertible by Temporal/Duration/from).
If you want to subtract two date-times and get a duration, use Temporal/ZonedDateTime/since or Temporal/ZonedDateTime/until instead.
Syntax
subtract(duration)
subtract(duration, options)
Parameters
duration- : A string, an object, or a Temporal.Duration instance representing a duration to subtract from this date-time. It is converted to a
Temporal.Durationobject using the same algorithm as Temporal/Duration/from.
- : A string, an object, or a Temporal.Duration instance representing a duration to subtract from this date-time. It is converted to a
options- : An object containing the following property:
overflow- : 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 RangeError is thrown if the date component is out of range.
- : A string specifying the behavior when a date component is out of range. Possible values are:
- : An object containing the following property:
Return value
A new Temporal.ZonedDateTime object representing the date-time specified by the original ZonedDateTime, minus the duration.
Exceptions
- RangeError
- : Thrown if the result is not in the representable range, which is ±10<sup>8</sup> 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
Browser compatibility
See also
- Temporal.ZonedDateTime
- Temporal.Duration
- Temporal/ZonedDateTime/add
- Temporal/ZonedDateTime/since
- Temporal/ZonedDateTime/until
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
