【JavaScript ECMAScript】Date::Date.prototype.setHoursインスタンスメソッドの使い方
Date.prototype.setHours()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
Date.prototype.setHours()メソッドは、JavaScriptのDateオブジェクトが持つ日付と時刻の情報のうち、「時」の要素を設定するために使用されるメソッドです。このメソッドは、既存のDateインスタンスに対して、その時刻情報の中の「時」の値を指定した新しい値に変更します。
具体的には、第一引数に設定したい「時」の値を、0から23の範囲で指定します。また、オプションとして、分、秒、ミリ秒の値をそれぞれ第二、第三、第四引数で同時に設定することもできます。これらのオプション引数を省略した場合、対応する時刻要素は変更されずに現在の値が保持されます。
このメソッドを呼び出すと、対象のDateオブジェクトの内容が直接変更されます。戻り値としては、変更後のDateオブジェクトが表す、協定世界時(UTC)の1970年1月1日0時0分0秒からの経過ミリ秒数を数値で返します。
重要な点として、もし「時」や「分」などの引数の値が通常の有効範囲(例:時なら0〜23)を超えていた場合、Dateオブジェクトは自動的に日付を調整します。例えば、25時を設定すると翌日の1時として扱われ、日付も繰り上がります。この機能により柔軟な時刻設定が可能ですが、引数が範囲外の場合の自動調整の挙動には留意が必要です。
公式リファレンス: Date.prototype.setHours()
構文(syntax)
1const dateObject = new Date(); 2dateObject.setHours(10, 30, 0);
引数(parameters)
hourValue, minuteValue, secondValue, msValue
- hourValue: number: 設定したい時(0〜23)
- minuteValue: number = 0: 設定したい分(0〜59)。省略された場合は0になります。
- secondValue: number = 0: 設定したい秒(0〜59)。省略された場合は0になります。
- msValue: number = 0: 設定したいミリ秒(0〜999)。省略された場合は0になります。
戻り値(return)
number
このメソッドは、Dateオブジェクトが表す時刻のミリ秒単位での日付の表現を返します。