Temporal.PlainYearMonth.prototype.with()

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

Нет очевидного способа создать новый объект Temporal.PlainYearMonth, который представляет тот же год-месяц в другом календаре, поэтому, чтобы заменить его свойство calendarId, вам нужно сначала преобразовать его в объект Temporal.PlainDate, используя toPlainDate(), изменить календарь, а затем преобразовать обратно.

Синтаксис

with(info)
with(info, options)

Параметры

info

Объект, содержащий как минимум одно из свойств, распознаваемых Temporal.PlainYearMonth.from() (за исключением calendar): era и eraYear, month, monthCode, year. Неуказанные свойства используют значения из исходного года-месяца. Вам нужно предоставить только одно из month или monthCode, и одно из era и eraYear или year, и другое будет обновлено соответствующим образом.

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

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

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

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

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

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

"reject"

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

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

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

Исключения

TypeError

Генерируется в одном из следующих случаев:

• info не является объектом.
• options не является объектом или undefined.

RangeError

Генерируется в одном из следующих случаев:

• Предоставленные свойства, которые указывают на один и тот же компонент, противоречивы.
• Предоставленные нечисловые свойства недействительны; например, если monthCode никогда не является действительным кодом месяца в этом календаре.
• Предоставленные числовые свойства выходят за пределы диапазона, а options.overflow установлено в "reject".
• Результат не находится в представимом диапазоне, который составляет ±(10⁸ + 1) дней, или около ±273 972,6 лет, от эпохи Unix.

Примеры

Использование with()

const ym = Temporal.PlainYearMonth.from("2021-07");
const newYM = ym.with({ year: 2024 });
console.log(newYM.toString()); // "2024-07"

Дополнительные примеры см. в документации по отдельным свойствам, которые могут быть установлены с помощью with().

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

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

См. также

• Temporal.PlainYearMonth
• Temporal.PlainYearMonth.from()