Temporal.PlainYearMonth.prototype.subtract()

Метод subtract() экземпляров Temporal.PlainYearMonth возвращает новый объект Temporal.PlainYearMonth, представляющий данный год-месяц, сдвинутый назад на заданную длительность (в форме, преобразуемой с помощью Temporal.Duration.from()).

Если вы хотите вычесть два года-месяца и получить длительность, используйте вместо этого since() или until().

Синтаксис

subtract(duration)
subtract(duration, options)

Параметры

duration

Строка, объект или экземпляр Temporal.Duration, представляющий длительность, которую нужно вычесть из этого года-месяца. Он преобразуется в объект Temporal.Duration с использованием того же алгоритма, что и Temporal.Duration.from().

options Необязательно

Объект, содержащий следующее свойство:

overflow Необязательно

Строка, определяющая поведение, когда компонент даты выходит за пределы диапазона. Возможные значения:

"constrain" (по умолчанию)

Компонент даты ограничивается допустимым диапазоном.

"reject"

Генерируется RangeError, если компонент даты выходит за пределы диапазона.

Возвращаемое значение

Новый объект Temporal.PlainYearMonth, представляющий год-месяц, заданный исходным PlainYearMonth, за вычетом длительности.

Исключения

RangeError

Генерируется, если результат не находится в представимом диапазоне, который составляет ±(10⁸ + 1) дней, или около ±273 972,6 лет, от эпохи Unix.

Описание

Вычитание длительности эквивалентно добавлению ее отрицания, поэтому применяются все те же соображения. Вычитание положительной длительности начинается с конца года-месяца и движется назад, поэтому любое приращение, меньшее длины месяца, игнорируется.

Примеры

Вычитание длительности

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

Дополнительные примеры см. в add().

Спецификации

Совместимость с браузерами

См. также

• Temporal.PlainYearMonth
• Temporal.Duration
• Temporal.PlainYearMonth.prototype.add()
• Temporal.PlainYearMonth.prototype.since()
• Temporal.PlainYearMonth.prototype.until()