【JavaScript ECMAScript】Temporal::Temporal.Duration.prototype.yearsインスタンスアクセサプロパティの使い方

Temporal.Duration.prototype.yearsプロパティは、Temporal.Durationオブジェクトが表す期間のうち、年の成分を保持するプロパティです。このプロパティは、Temporal.Durationインスタンスが保持する時間的な長さから、具体的な「年」の数値を参照するために利用されます。

Temporal.Durationオブジェクトは、複数の時間単位（年、月、日、時間、分、秒、ミリ秒、マイクロ秒、ナノ秒）で構成される期間を表すためのものです。yearsプロパティにアクセスすることで、そのDurationオブジェクトに設定されている年の数値部分を直接取得できます。

このプロパティが返す値は、符号付きの整数型です。これは、期間が過去方向（負の期間）である場合にも対応できるようにするためです。例えば、1年間の負の期間を表すnew Temporal.Duration(-1)のように作成されたDurationオブジェクトのyearsプロパティは-1を返します。

Temporal.Duration.prototype.yearsは読み取り専用のアクセサープロパティであり、値を直接変更することはできません。期間の年の値を変更したい場合は、Temporal.Durationオブジェクトの他のメソッド（例: with()）を使用して新しいDurationオブジェクトを生成する必要があります。

システムエンジニアを目指す初心者の方々にとって、このプロパティは時間計算や期間管理を行う際に、特定の期間の「年」の部分だけを抽出したい場合に非常に役立ちます。例えば、ユーザーが入力した期間情報から年数を取得し、その後の処理に利用するといった場面で活用できます。

Copy
1const duration = Temporal.Duration.from({ years: 1, months: 6 });
2const yearsValue = duration.years;

引数なし

引数はありません

number

このプロパティは、Temporal.Durationオブジェクトが表す期間における年数を数値で返します。