【JavaScript ECMAScript】Temporal::Temporal.PlainYearMonth.prototype.withインスタンスメソッドの使い方

Temporal.PlainYearMonth.prototype.with()メソッドは、既存の Temporal.PlainYearMonth オブジェクトの特定の部分を変更し、その結果として新しい Temporal.PlainYearMonth オブジェクトを生成するメソッドです。このメソッドは、元のオブジェクトの状態を保持しつつ、年や月などの情報を柔軟に調整したい場合に利用されます。

引数としては、変更したいプロパティを含むオブジェクトと、オプションの挙動を設定するオブジェクトの二つを受け取ります。第一引数には、変更を加えたいプロパティ、例えば year や month とその新しい値を指定します。これにより、元のオブジェクトの対応するプロパティが指定された値で上書きされます。第二引数のオプションオブジェクトでは、日付計算で範囲外の値が発生した場合の処理（例えば 'constrain' オプションで最も近い有効な日付に調整する挙動など）を制御できます。

このメソッドの重要な特徴は、イミュータブル（不変）である点です。呼び出し元の Temporal.PlainYearMonth オブジェクト自体は一切変更されず、常に新しい Temporal.PlainYearMonth オブジェクトが戻り値として返されます。これにより、元のデータの整合性を保ちながら、安全に年月の情報を操作できます。既存の年月の情報を基に、一部の要素だけを効率的に変更して異なる年月の表現を生成したい場合に、このメソッドは非常に有用です。

Copy
1aPlainYearMonth.with(properties);

temporalYearMonthLike, options = {}

• temporalYearMonthLike: 年月を表すオブジェクトまたは、年と月を指定するプロパティを持つオブジェクト
• options: オプションを指定するオブジェクト。空の場合、デフォルト値が使用されます

Temporal.PlainYearMonth

指定されたプロパティを新しい値に更新した、新しい Temporal.PlainYearMonth オブジェクトを返します。