【JavaScript ECMAScript】Temporal::Temporal.PlainDateTime.compare静的メソッドの使い方

Temporal.PlainDateTime.compare()メソッドは、2つのTemporal.PlainDateTimeオブジェクトを比較し、それらの相対的な順序を示す数値を返す静的メソッドです。このメソッドは、タイムゾーンやUTCオフセットを含まない、特定の日付と時刻情報のみを持つ2つの日時を比較する際に使用されます。主に、ある日時が別の日時より前か、後か、または同じであるかをプログラム的に判断するために設計されています。

比較の結果は数値で示されます。最初の引数として渡されたPlainDateTimeが2番目の引数よりも過去の日時を表す場合、このメソッドは負の数を返します。もし最初の引数が2番目の引数よりも未来の日時を表す場合、正の数を返します。そして、2つの引数がまったく同じ日時を表す場合には、0が返されます。

このメソッドはTemporal.PlainDateTimeクラスの静的メソッドであるため、PlainDateTimeオブジェクトのインスタンスを作成することなく、クラス名から直接呼び出すことができます。例えば、日付のソート処理において比較関数として利用したり、特定の期間内にある日時かどうかを判定する条件分岐など、日時データを扱う様々な場面でその順序を正確に評価するために非常に役立ちます。Temporal APIの一部として、日時に関する堅牢な比較機能を提供し、開発者が時間に関する複雑なロジックをより安全に実装できるよう支援します。

Copy
1const plainDateTime1 = Temporal.PlainDateTime.from('2023-01-01T10:00:00');
2const plainDateTime2 = Temporal.PlainDateTime.from('2023-01-01T11:00:00');
3const comparisonResult = Temporal.PlainDateTime.compare(plainDateTime1, plainDateTime2);

one, two

• one: Temporal.PlainDateTime: 比較対象となる最初の PlainDateTime オブジェクト
• two: Temporal.PlainDateTime: 比較対象となる2番目の PlainDateTime オブジェクト

Number

Temporal.PlainDateTime.compare() メソッドは、2つの PlainDateTime オブジェクトを比較した結果を数値で返します。比較対象の最初の PlainDateTime が2番目の PlainDateTime より前であれば -1、同じであれば 0、後であれば 1 が返されます。