【Node.js24.x】Date::setUTCHours()メソッドの使い方
setUTCHoursメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
setUTCHoursメソッドは、Node.js環境におけるDateオブジェクトの協定世界時(UTC)に基づいた時刻を設定するために使用されるメソッドです。このメソッドは、既存のDateオブジェクトに対して、時、分、秒、ミリ秒の各要素を協定世界時として更新します。
引数には、設定したい時(0から23までの整数)、分(0から59までの整数)、秒(0から59までの整数)、ミリ秒(0から999までの整数)をそれぞれ数値で指定します。これらの引数は省略可能であり、省略された場合は、元のDateオブジェクトに設定されている現在のUTCの値が維持されます。例えば、時のみを指定し、分、秒、ミリ秒の引数を省略した場合、これらの要素は既存のDateオブジェクトの値がそのまま使用され、時だけが更新されます。
協定世界時(UTC)は、世界中で共通に利用される標準時であり、特定のタイムゾーンに依存しません。そのため、異なる地域やタイムゾーンをまたいで時刻データを扱う国際的なアプリケーションやシステムにおいて、一貫性のある時刻処理を行う際に非常に重要な役割を果たします。このメソッドはローカルタイムではなく、あくまでUTCでの時刻を操作する点に注意が必要です。
setUTCHoursメソッドは、指定された値でDateオブジェクトの時刻部分を更新した後、1970年1月1日0時0分0秒UTCからの経過ミリ秒数を数値として返します。この戻り値を利用することで、時刻が更新されたことを確認したり、他の日付や時刻の計算に利用したりすることができます。
構文(syntax)
1const dateObj = new Date('2023-10-26T00:00:00Z'); 2dateObj.setUTCHours(14, 30, 0, 500);
引数(parameters)
hoursValue, minutesValue, secondsValue, msValue
- hoursValue: number: UTCでの時間を設定する数値 (0-23)
- minutesValue: number: UTCでの分を設定する数値 (0-59)
- secondsValue: number: UTCでの秒を設定する数値 (0-59)
- msValue: number: UTCでのミリ秒を設定する数値 (0-999)
戻り値(return)
number
Dateオブジェクトで設定されたUTC(協定世界時)の時間を表すミリ秒単位の数値を返します。