【JavaScript ECMAScript】Date::Date.prototype.setUTCHoursインスタンスメソッドの使い方
Date.prototype.setUTCHours()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Date.prototype.setUTCHours()メソッドは、指定されたDateオブジェクトのUTC(協定世界時)における「時」「分」「秒」「ミリ秒」の値を設定するメソッドです。このメソッドは、タイムゾーンの影響を受けずに日付と時刻を設定したい場合に特に役立ちます。
引数には、まず設定したい時を数値(0から23)で指定します。これに続いて、オプションで分(0から59)、秒(0から59)、ミリ秒(0から999)をそれぞれ数値で指定できます。これらのオプションの引数を省略した場合、省略された値は0に設定されます。例えば、時だけを指定して分以下を省略すると、そのDateオブジェクトの分、秒、ミリ秒はすべて0にリセットされます。
引数として指定した値が通常の範囲(例: 時が23を超える、分が59を超える)を超えてもエラーにはなりません。代わりに、自動的に日付が調整されます。例えば、時として24を指定すると、Dateオブジェクトは翌日の0時として扱われます。
このメソッドを呼び出すと、元のDateオブジェクトの時刻情報が直接変更されます。そして、変更後のDateオブジェクトが示す、1970年1月1日0時0分0秒UTCからの経過ミリ秒数を数値として返します。ローカルタイムゾーンに基づいて時刻を設定するsetHours()メソッドとは異なり、このsetUTCHours()は常にUTCに基づいて動作するため、国際的なアプリケーションやタイムゾーンに依存しないデータ処理において正確な時刻管理を実現するために重要な役割を果たします。
構文(syntax)
1const dateObj = new Date(); 2dateObj.setUTCHours(10, 30, 0, 0);
引数(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
このメソッドは、UTC(協定世界時)での日付オブジェクトの時を設定し、その結果、1970年1月1日00:00:00 UTCからの経過ミリ秒数を表す数値を返します。