Temporal.ZonedDateTime.prototype.subtract()

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

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

Синтаксис

subtract(duration)
subtract(duration, options)

Параметры

duration

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

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

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

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

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

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

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

"reject"

Выбрасывается исключение RangeError, если компонент даты находится вне диапазона.

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

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

Исключения

RangeError

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

Описание

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

Примеры

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

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]

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

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

См. также

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