【JavaScript ECMAScript】Temporal::Temporal.PlainTime.prototype.withインスタンスメソッドの使い方

Temporal.PlainTime.prototype.with()メソッドは、既存のTemporal.PlainTimeオブジェクトの特定の時刻要素を変更し、その変更が適用された新しいTemporal.PlainTimeオブジェクトを生成するメソッドです。このメソッドは、元のオブジェクトが持つ時、分、秒、ミリ秒などの情報の一部だけを更新したい場合に利用されます。

引数には、変更したい時刻のフィールドとその新しい値をプロパティとして持つオブジェクトを渡します。例えば、hour（時）、minute（分）、second（秒）、millisecond（ミリ秒）、microsecond（マイクロ秒）、nanosecond（ナノ秒）などを指定できます。指定しなかったフィールドの値は、元のTemporal.PlainTimeオブジェクトのものがそのまま引き継がれます。

このメソッドの重要な特性は、元のTemporal.PlainTimeオブジェクトを直接変更しない「イミュータブル」な操作であることです。常に新しいTemporal.PlainTimeオブジェクトを生成して返します。そのため、元の時刻データに影響を与えることなく、安全に時刻の調整を行うことが可能です。例えば、現在の時刻の分だけを変更して、時や秒はそのままにしたいといった柔軟な操作を実現できます。オプションとして、オーバーフロー時の挙動などを制御する設定オブジェクトを第2引数に渡すことも可能ですが、基本的な使用では省略されます。

Copy
1const myPlainTime = new Temporal.PlainTime(12, 30, 0);
2const newPlainTime = myPlainTime.with({ hour: 13, minute: 45 });

temporalTimeLike, options

• temporalTimeLike: 年月日時分秒ミリ秒マイクロ秒ナノ秒のいずれかを含む、時間情報を表すオブジェクトまたは文字列。
• options: プロパティを上書きするためのオブジェクト。

Temporal.PlainTime

指定されたプロパティやメソッドが持つ値、または返される値を説明します。

Temporal.PlainTime.prototype.with() の戻り値は Temporal.PlainTime です。これは、元の Temporal.PlainTime オブジェクトのプロパティの一部を変更した、新しい Temporal.PlainTime オブジェクトを返します。