【JavaScript ECMAScript】Temporal::Temporal.PlainDate.prototype.subtractインスタンスメソッドの使い方
Temporal.PlainDate.prototype.subtract()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainDate.prototype.subtract()メソッドは、日付と時刻の国際標準APIであるTemporalの一部として提供される、Temporal.PlainDateオブジェクトのインスタンスメソッドです。このメソッドは、特定の「日付のみ」を表すTemporal.PlainDateオブジェクトに対して、指定された期間（年、月、日、週など）を減算し、その結果として新しいTemporal.PlainDateオブジェクトを生成します。
主に、基準となる日付から過去の日付を計算する際に使用されます。例えば、「今日から5日前の日付」や「あるイベントの3ヶ月前の日付」などをプログラムで正確に算出する場合に非常に役立ちます。減算する期間は、Temporal.Durationオブジェクトを用いるか、あるいは日数や月数などのプロパティを持つプレーンなJavaScriptオブジェクトとして柔軟に指定することが可能です。
このメソッドの大きな特徴は、不変性（immutable）の原則に従う点です。つまり、subtract()メソッドを実行しても、呼び出し元のTemporal.PlainDateオブジェクト自体は一切変更されません。常に新しい日付オブジェクトが結果として返されるため、意図しないデータの変更を防ぎ、予測可能なコードを記述することができます。システムエンジニアを目指す初心者の方にとって、複雑な日付計算を安全かつ効率的に行うための基本的なツールとして理解しておくべき重要な機能です。
構文(syntax)
1const plainDate = Temporal.PlainDate.from('2023-10-26'); 2const subtractedDate = plainDate.subtract({ days: 5 });
引数(parameters)
durationLike
- durationLike: Temporal.Duration または Temporal.Duration.from() に渡せる形式のオブジェクト。日付から減算する期間を指定します。
戻り値(return)
Temporal.PlainDate
指定された日付から指定された期間を減算した新しい Temporal.PlainDate オブジェクトを返します。