【JavaScript ECMAScript】Temporal::Temporal.PlainYearMonth.prototype.sinceインスタンスメソッドの使い方
Temporal.PlainYearMonth.prototype.since()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainYearMonth.prototype.since()メソッドは、Temporal.PlainYearMonthオブジェクトのインスタンスが表す年と月から、別のTemporal.PlainYearMonthオブジェクトが表す年と月までの期間を計算し、その結果をTemporal.Durationオブジェクトとして返すメソッドです。
このメソッドは、二つの年月の差分を求める際に利用され、呼び出し元の年月から引数として指定された年月を「差し引いた」形の期間を計算します。例えば、ある年月から別の年月までの経過時間や、特定の将来の年月までの残り時間を知りたい場合に有用です。結果として得られる期間は、年数と月数を含み、呼び出し元の年月が引数の年月よりも「後」であれば正の期間が、逆に「前」であれば負の期間が示されます。計算の際には、どの単位で期間を表現するか(例えば、年単位か、月単位か)、また期間の丸め方や、計算に使用する最大単位および最小単位といった詳細なオプションを指定することも可能です。これにより、用途に応じた柔軟な期間計算が可能となります。Temporal.PlainYearMonthは日付や時刻のうち年と月のみを扱うため、このsince()メソッドも時間帯や日以下の詳細を考慮せず、純粋に年月の差分を求める場合に特化しています。したがって、年月の期間計算を正確に行いたいシステムエンジニアの業務において、非常に役立つ機能と言えます。
構文(syntax)
1temporalPlainYearMonthInstance.since(otherPlainYearMonth[, options]);
引数(parameters)
other, options
- other: Temporal.PlainYearMonth: 比較対象となる別の PlainYearMonth オブジェクト
- options: object: オプションを指定するオブジェクト (省略可能)
戻り値(return)
Temporal.Duration
Temporal.PlainYearMonth.prototype.since()メソッドは、二つのTemporal.PlainYearMonthオブジェクトの差をTemporal.Durationオブジェクトとして返します。