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

Temporal.PlainDate.prototype.until()メソッドは、ある日付から別の特定の日付までの期間を計算するメソッドです。このメソッドは、Temporal.PlainDateオブジェクトのインスタンスに対して呼び出され、タイムゾーンやサマータイムの影響を受けない「プレーン」な日付としての期間の差分を正確に算出します。

第一引数には、期間の終了点となるTemporal.PlainDateインスタンスを指定します。これにより、メソッドが呼び出された日付から、指定された日付までの間の期間が計算されます。第二引数にはオプションで、計算される期間の単位や丸め処理を詳細に制御するためのオプションオブジェクトを渡すことができます。例えば、期間を「年」「月」「日」のいずれかの単位で計算するか、またはどのように端数を処理するかなどを指定することが可能です。

計算結果として、このメソッドはTemporal.Durationオブジェクトを返します。このTemporal.Durationオブジェクトには、年、月、日といった各単位での期間の構成要素が格納されており、その期間の具体的な内訳を知ることができます。

このメソッドは、例えば今日からプロジェクトの締め切りまでの残りの日数や、あるイベントから次のイベントまでの経過月数を計算するといったシナリオで非常に役立ちます。従来のJavaScriptのDateオブジェクトでは複雑になりがちだった日付間の期間計算を、より直感的かつ厳密に行うための強力なツールとして提供されています。システムエンジニアにとって、日付計算のロジックを簡潔かつ正確に実装するために不可欠な機能の一つです。

Copy
1const plainDate1 = new Temporal.PlainDate(2023, 1, 1);
2const plainDate2 = new Temporal.PlainDate(2024, 1, 1);
3const duration = plainDate1.until(plainDate2);

other, options

• other: Temporal.PlainDate|Temporal.TimeZone
• options: Temporal.DateUntilOptions|undefined

Temporal.Duration

Temporal.PlainDate.prototype.until() メソッドは、呼び出し元の日付と引数で指定された日付の間の期間を Temporal.Duration オブジェクトとして返します。この Duration オブジェクトには、年、月、日などの差分が含まれます。