The subtract() method of Temporal.PlainYearMonth instances returns a new Temporal.PlainYearMonth object representing this year-month moved backward by a given duration (in a form convertible by Temporal/Duration/from).
If you want to subtract two year-months and get a duration, use Temporal/PlainYearMonth/since or Temporal/PlainYearMonth/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 year-month. 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 year-month. 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.PlainYearMonth object representing the year-month specified by the original PlainYearMonth, minus the duration.
Exceptions
- RangeError
- : Thrown if the result is not in the representable range, which is ±(10<sup>8</sup> + 1) 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. Subtracting a positive duration starts from the end of the year-month and moves backward, so any increment smaller than the month's length is ignored.
Examples
Subtracting a duration
const start = Temporal.PlainYearMonth.from("2022-01");
const end = start.subtract({ years: 1, months: 2, weeks: 3, days: 4 });
console.log(end.toString()); // 2020-11
For more examples, see Temporal/PlainYearMonth/add.
Specifications
Browser compatibility
See also
- Temporal.PlainYearMonth
- Temporal.Duration
- Temporal/PlainYearMonth/add
- Temporal/PlainYearMonth/since
- Temporal/PlainYearMonth/until
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
