【JavaScript ECMAScript】Temporal::Temporal.PlainDateTime.prototype.withインスタンスメソッドの使い方
Temporal.PlainDateTime.prototype.with()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainDateTime.prototype.with()メソッドは、既存のTemporal.PlainDateTimeオブジェクトの特定の日付や時刻の要素を変更し、その変更が適用された結果として新しいPlainDateTimeオブジェクトを生成するメソッドです。
このメソッドは、呼び出し元のオブジェクト自体を直接変更するのではなく、常に新しいPlainDateTimeオブジェクトを返します。この「不変性」の原則により、予期せぬ副作用を防ぎ、コードの信頼性を高めることができます。
引数として、変更したい日付や時刻のフィールド(例えば、年、月、日、時、分など)と、それに設定したい新しい値をプロパティとして持つオブジェクトを受け取ります。例えば、既存の日付オブジェクトの年だけを特定の値に変更したり、月と日を同時に変更したりすることが可能です。また、日付や時刻のオーバーフロー(例:存在しない2月30日を指定した場合など)の処理方法を制御するためのオプションも指定できます。
このメソッドは、ある時点から特定の日付・時刻要素を変更した別の時点のオブジェクトを作成したい場合に特に有用です。例えば、ある日の「来年の同じ日」や「今日の午前9時」を計算する際に活用できます。このように、with()メソッドは、日付や時刻の値を安全かつ柔軟に操作するための、Temporal APIにおける重要な機能の一つです。
構文(syntax)
1plainDateTime.with(fields, options)
引数(parameters)
temporalFields, options
- temporalFields: 変更したい日時フィールドを指定するオブジェクト
- options: オプションを指定するオブジェクト
戻り値(return)
Temporal.PlainDateTime
指定された日付と時刻の要素を持つ新しいTemporal.PlainDateTimeオブジェクトを返します。