【JavaScript ECMAScript】Temporal::Temporal.PlainYearMonth.prototype.addインスタンスメソッドの使い方
Temporal.PlainYearMonth.prototype.add()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainYearMonth.prototype.add()メソッドは、年と月のみを扱うTemporal.PlainYearMonthオブジェクトに対して、指定された期間を加算して、新しいTemporal.PlainYearMonthオブジェクトを生成するメソッドです。このメソッドは、JavaScriptで日付と時刻をより堅牢に扱うためのTemporal APIの一部として提供されています。
Temporal.PlainYearMonthオブジェクトは、タイムゾーンや日、時間情報を持たず、カレンダー上の年と月のみを表します。add()メソッドは、引数として加算したい期間(例えば、数年や数ヶ月)を示すオブジェクトを受け取ります。この期間に基づいて、現在のPlainYearMonthオブジェクトに計算を適用し、結果として得られる新しい年と月を持つTemporal.PlainYearMonthオブジェクトを返します。
特に重要な点として、このメソッドは元のTemporal.PlainYearMonthオブジェクトの内容を直接変更することはありません。代わりに、加算処理の結果として得られる全く新しいTemporal.PlainYearMonthオブジェクトを作成して返します。この「不変性」と呼ばれる特性は、日付計算における予期せぬ副作用を防ぎ、コードの信頼性を高める上で非常に重要です。例えば、現在の月に対して数ヶ月後の月を計算する際などに、安全かつ正確な日付操作を実現できます。これにより、JavaScriptにおける日付処理をより直感的で堅牢に行うことができます。
構文(syntax)
1const plainYearMonth = new Temporal.PlainYearMonth(2023, 10); 2const resultPlainYearMonth = plainYearMonth.add({ years: 1, months: 2 });
引数(parameters)
duration
- duration: Temporal.Duration: 追加する期間を指定します。正の値は未来へ、負の値は過去への期間を表します。
戻り値(return)
Temporal.PlainYearMonth
指定された年月の値に、指定された年数、月数、または年月の組み合わせを加算した新しい Temporal.PlainYearMonth オブジェクトを返します。