Temporal.PlainYearMonth.prototype.with()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The with() method of Temporal.PlainYearMonth instances returns a new Temporal.PlainYearMonth object representing this year-month with some fields replaced by new values. Because all Temporal objects are designed to be immutable, this method essentially functions as the setter for the year-month's fields.

There's no obvious way to create a new Temporal.PlainYearMonth object that represents the same year-month in a different calendar, so to replace its calendarId property, you need to convert it to a Temporal.PlainDate object first using toPlainDate(), change the calendar, and then convert it back.

Syntax

with(info)
with(info, options)

Parameters

info

An object containing at least one of the properties recognized by Temporal.PlainYearMonth.from() (except calendar): era and eraYear, month, monthCode, year. Unspecified properties use the values from the original year-month. You only need to provide one of month or monthCode, and one of era and eraYear or year, and the other will be updated accordingly.

options Optional

An object containing the following property:

overflow Optional

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.

Return value

A new Temporal.PlainYearMonth object, where the fields specified in info that are not undefined are replaced by the corresponding values, and the rest of the fields are copied from the original date.

Exceptions

TypeError

Thrown in one of the following cases:

info is not an object.
options is not an object or undefined.

RangeError

Thrown in one of the following cases:

The provided properties that specify the same component are inconsistent.
The provided non-numerical properties are not valid; for example, if monthCode is never a valid month code in this calendar.
The provided numerical properties are out of range, and options.overflow is set to "reject".
The result is not in the representable range, which is ±(10⁸ + 1) days, or about ±273,972.6 years, from the Unix epoch.

Examples

Using with()

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

For more examples, see the documentation for the individual properties that can be set using with().

Specifications

Specification
Temporal # sec-temporal.plainyearmonth.prototype.with

Browser compatibility

	Desktop					Mobile						Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	Deno	Node.js
`with`	No	No	139	No	No	No	139	No	No	No	No	1.40	No