【JavaScript ECMAScript】Date::Date.prototype.setUTCMinutesインスタンスメソッドの使い方
Date.prototype.setUTCMinutes()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Date.prototype.setUTCMinutes()メソッドは、指定されたDateオブジェクトのUTC(協定世界時)における「分」の値を設定するメソッドです。このメソッドを利用することで、日付と時刻の分単位の情報を正確に制御できます。
このメソッドには、複数の引数を指定できます。一つ目の引数である minutesValue は必須であり、設定したい分を0から59の範囲で表す整数値を指定します。この値が59を超えるような大きな数値であった場合でも、JavaScriptは自動的に時間、日、月、そして年を適切に調整します。例えば、60を指定すると1時間繰り上がり、分は0として扱われます。
二つ目の引数 secondsValue は任意で、設定したい秒を0から59の範囲で表す整数値を指定します。この引数を省略した場合、現在のDateオブジェクトが持つUTCでの秒の値がそのまま利用されます。三つ目の引数 msValue も任意で、設定したいミリ秒を0から999の範囲で表す整数値を指定します。こちらも省略された場合は、現在のDateオブジェクトのUTCでのミリ秒の値が保持されます。
たとえば、minutesValue のみ指定し、secondsValue と msValue を省略した場合、秒とミリ秒の値は元のDateオブジェクトの値が維持されます。同様に、minutesValue と secondsValue を指定し、msValue を省略した場合は、ミリ秒の値が維持されます。
このメソッドは、呼び出し元のDateオブジェクト自身を変更します。そして、設定が正常に行われると、1970年1月1日0時0分0秒(UTC)からの経過ミリ秒数を表す数値が戻り値として返されます。この戻り値によって、更新後のDateオブジェクトの内部的な時刻値を確認することができます。
構文(syntax)
1dateObj.setUTCMinutes(minutesValue, secondsValue);
引数(parameters)
minutesValue, secondsValue, msValue
- minutesValue: number: UTCで設定する分を指定します。0から59の整数である必要があります。
- secondsValue: number = 0: UTCで設定する秒を指定します。0から59の整数である必要があります。省略された場合は0が使用されます。
- msValue: number = 0: UTCで設定するミリ秒を指定します。0から999の整数である必要があります。省略された場合は0が使用されます。
戻り値(return)
Number
このメソッドは、UTC(協定世界時)における分を設定した後の、Dateオブジェクトのミリ秒単位でのエポックタイム(1970年1月1日午前0時からの経過時間)を返します。