【JavaScript ECMAScript】Temporal::Temporal.PlainDateTime.prototype.roundインスタンスメソッドの使い方
Temporal.PlainDateTime.prototype.round()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainDateTime.prototype.round()メソッドは、Temporal.PlainDateTimeオブジェクトが保持する日時情報を指定された単位で丸める(四捨五入する)メソッドです。このメソッドは、日付や時刻の表示粒度を調整したい場合や、特定の時間単位で値を揃えたい場合に非常に役立ちます。
具体的には、年、月、日、時間、分、秒、ミリ秒、マイクロ秒、ナノ秒といった様々な時間単位を指定して、日時を丸めることが可能です。丸める単位はオプションオブジェクトのlargestUnitまたはsmallestUnitプロパティで指定し、roundingModeプロパティで'halfExpand'(四捨五入)、'ceil'(切り上げ)、'floor'(切り捨て)、'trunc'(ゼロ方向への丸め)などの丸め方を細かく制御できます。また、incrementプロパティを使用して、指定単位の増分(例:5分単位で丸める)も設定できます。
round()メソッドは、丸められた日時情報を持つ新しいTemporal.PlainDateTimeオブジェクトを返します。元のオブジェクトは変更されず、不変性が保たれます。例えば、正確な秒までは不要で、分単位で日時を表示したい場合や、レポート作成のために時間を最も近い時間に丸めたい場合などに活用できます。これにより、日時データを柔軟に扱い、要件に応じた形に整形することが可能になります。
構文(syntax)
1const plainDateTime = Temporal.PlainDateTime.from('2023-10-27T10:30:45.123456789'); 2const roundedDateTime = plainDateTime.round({ smallestUnit: 'minute', roundingMode: 'halfExpand' });
引数(parameters)
roundTo
- roundTo: Temporal.DateTime.from(roundTo): DateTime.from()で解釈可能な文字列、または Temporal.Calendar.ISO.dateAdd() および Temporal.Calendar.ISO.timeAdd() で使用できる Temporal.Duration.from() の表す期間を 時間、分、秒、ミリ秒、マイクロ秒、ナノ秒、 またはそれらの組み合わせのいずれかに 丸めるために使用される値。
戻り値(return)
Temporal.PlainDateTime
指定された時間間隔で丸められた新しい Temporal.PlainDateTime オブジェクトを返します。