【JavaScript ECMAScript】Temporal::Temporal.Duration.prototype.totalインスタンスメソッドの使い方
Temporal.Duration.prototype.total()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.Duration.prototype.total()メソッドは、Temporal.Durationオブジェクトが表す時間の期間を、指定された単一の単位で合計した数値として計算し、返すメソッドです。このメソッドを使用すると、年、月、日、時間、分、秒などの複数の単位で構成される期間を、一つの共通の単位(例えば「秒」や「日」)に変換して評価することができます。
たとえば、「1時間と30分」という期間を持つTemporal.Durationオブジェクトに対して、このメソッドを「分」単位で実行すると、合計値として90が返されます。
このメソッドはオプションオブジェクトを引数として受け取ります。このオプションオブジェクトには、合計する単位を指定するunitプロパティ(例: "years", "months", "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds")を含めることができます。また、計算結果の小数点以下の桁数を指定するdecimalPlacesや、丸め方を指定するroundingMode(例: "halfExpand", "trunc", "ceil", "floor")などのプロパティも設定でき、計算の精度と挙動を細かく制御することが可能です。
返される値は、指定された単位で表現された期間の合計値を示す数値(number)です。これにより、複雑な期間を統一された基準で比較したり、他の数値計算に利用したりすることが容易になります。
構文(syntax)
1const myDuration = new Temporal.Duration(0, 0, 0, 0, 1, 30, 0, 0, 0, 0); 2const totalValue = myDuration.total({ unit: 'minutes' });
引数(parameters)
options
- options?: Temporal.TotalOf of a Temporal.Duration object: 変換する単位を指定するオブジェクト。指定しない場合は、最も小さい単位(ナノ秒)から最も大きい単位(年)までの合計が計算されます。
戻り値(return)
number
Temporal.Duration.prototype.total() メソッドは、指定された単位置の合計期間を表す数値を返します。