【JavaScript ECMAScript】Temporal::Temporal.PlainDate.prototype.sinceインスタンスメソッドの使い方
Temporal.PlainDate.prototype.since()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainDate.prototype.since()メソッドは、日付のみを扱うTemporal.PlainDateインスタンス間での期間を計算し、その結果をTemporal.Durationオブジェクトとして返すメソッドです。このメソッドは、呼び出し元のTemporal.PlainDateオブジェクトから、引数に指定された別のTemporal.PlainDateオブジェクトまでの期間を計測します。例えば、ある特定の日付から今日までの経過日数や、あるイベント開始日から終了日までの月数などを計算する際に利用できます。
戻り値であるTemporal.Durationオブジェクトは、年、月、日といった期間の構成要素を保持しており、それらの期間を正確に表現します。since()メソッドは、第三引数としてオプションオブジェクトを受け入れます。このオプションオブジェクトを使用することで、期間の計算単位(例えば「日」単位のみ、または「月」単位まで、など)や、計算結果が指定された単位で割り切れない場合の丸め処理の方法(切り上げ、切り捨て、四捨五入など)を詳細に指定することが可能です。
時間情報を含まない日付間の期間を、柔軟かつ正確に計算できるため、システムのスケジュール管理、レポート作成、ユーザーインターフェースにおける期間表示など、多岐にわたる日付関連の処理において重要な役割を果たします。これにより、複雑な日付計算ロジックの実装を簡潔にし、エラーのリスクを低減することができます。
構文(syntax)
1const startDate = Temporal.PlainDate.from('2023-01-01'); 2const endDate = Temporal.PlainDate.from('2023-01-15'); 3 4startDate.since(endDate);
引数(parameters)
other, options
- other: Temporal.PlainDate | Temporal.TimeZoneProtocol | Temporal.ZonedDateTimeProtocol: 比較対象の別のTemporal.PlainDateオブジェクト、または時間帯情報を持つプロトコルオブジェクト。
- options: object = { smallestUnit: "nanosecond", largestUnit: "auto", smallest: 0, largest: Infinity }: 差分計算の単位や範囲を指定するオプションオブジェクト。
戻り値(return)
Temporal.Duration
指定された2つの日付の差分を表すTemporal.Durationオブジェクトを返します。