Temporal.PlainDateTime.prototype.subtract()

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

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

Синтаксис

subtract(duration)
subtract(duration, options)

Параметры

duration

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

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

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

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

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

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

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

"reject"

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

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

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

Исключения

RangeError

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

Описание

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

Примеры

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

const start = Temporal.PlainDateTime.from("2022-01-01T12:34:56");
const end = start.subtract({
  years: 1,
  months: 2,
  weeks: 3,
  days: 4,
  hours: 5,
  minutes: 6,
  seconds: 7,
  milliseconds: 8,
});
console.log(end.toString()); // 2020-10-07T07:28:48.992

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

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

См. также

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