【JavaScript ECMAScript】Temporal::Temporal.PlainDateTime.prototype.addインスタンスメソッドの使い方
Temporal.PlainDateTime.prototype.add()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainDateTime.prototype.add()メソッドは、Temporal.PlainDateTimeオブジェクトに指定された時間量を加算し、その結果として新しいTemporal.PlainDateTimeオブジェクトを生成して返すメソッドです。Temporal.PlainDateTimeオブジェクトは、タイムゾーン情報を持たず、カレンダー上の日付と時刻を正確に表します。このadd()メソッドを使用すると、既存のPlainDateTimeインスタンスに対して、年、月、日、時間、分、秒などの任意の時間単位を組み合わせて加算できます。
引数には、加算したい時間量を定義したTemporal.Durationオブジェクト、またはそれに変換可能なプロパティを持つオブジェクト(例えば、日数を表す{ days: 1 }など)を指定します。add()メソッドの大きな特徴は、元のPlainDateTimeオブジェクト自体を変更しない「不変性」にあります。代わりに、加算後の新しい日付と時刻を表すTemporal.PlainDateTimeのインスタンスを新たに生成して返します。これにより、元のデータが意図せず変更されることを防ぎ、安全で予測しやすい日付と時刻の操作が可能になります。
このメソッドは、特定の日付や時刻から未来の時点を計算したり、イベントの期限を算出したりするなど、日付と時刻の計算を伴う様々なシナリオで活用されます。システム開発において、日時計算の正確性と信頼性を確保するために重要な機能です。
構文(syntax)
1const plainDateTime = Temporal.PlainDateTime.from('2023-10-27T10:00:00'); 2const newPlainDateTime = plainDateTime.add({ years: 1, months: 2, days: 3, hours: 4, minutes: 5, seconds: 6 });
引数(parameters)
temporalDurationLike
- temporalDurationLike: 追加する期間を表すオブジェクト。
Temporal.Durationオブジェクト、または期間を表すプロパティを持つオブジェクト (例:{ years: 1, months: 2 }) を指定します。
戻り値(return)
Temporal.PlainDateTime
指定された日時(年月日、時分秒、ミリ秒、マイクロ秒、ナノ秒)に、指定された期間(年、月、週、日、時、分、秒、ミリ秒、マイクロ秒、ナノ秒)を加算した新しい Temporal.PlainDateTime オブジェクトを返します。