【JavaScript ECMAScript】Date::Date.prototype.setSecondsインスタンスメソッドの使い方
Date.prototype.setSeconds()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Date.prototype.setSeconds()メソッドは、指定されたDateオブジェクトの「秒」の値を設定し、任意で「ミリ秒」の値も同時に設定するメソッドです。このメソッドは、呼び出されたDateオブジェクト自体を変更する、いわゆる破壊的な操作を行います。
引数として、まず必須の秒の値を指定します。秒の値は通常0から59の範囲で整数として指定しますが、この範囲を超える値を指定することも可能です。例えば、60を指定すると1分が追加され、秒は0として扱われます。また、二つ目の引数としてオプションでミリ秒の値を整数で指定できます。ミリ秒の値も通常0から999の範囲ですが、同様に範囲を超える値を指定すると、秒の値が自動的に調整されます。
このメソッドを呼び出すと、Dateオブジェクトの秒とミリ秒が指定された値に更新され、その変更後のDateオブジェクトが表す日付と時刻のミリ秒表現が数値として返されます。この数値は、1970年1月1日00:00:00 UTCからの経過ミリ秒数です。
このメソッドは、既存のDateオブジェクトの時刻情報を柔軟に変更したい場合に非常に有用です。ただし、秒の設定はUTCではなく、ブラウザや実行環境のローカルタイムゾーンに基づいて行われる点に注意が必要です。また、引数に有効ではない値を指定した場合、結果として日付が不正になり、戻り値がNaN(Not-a-Number)となることがあります。
構文(syntax)
1const dateObject = new Date(); 2dateObject.setSeconds(30, 500);
引数(parameters)
secValue, msValue
- secValue: number: 設定する秒数を指定します。0から59の範囲で指定します。
- msValue: number: 設定するミリ秒数を指定します。0から999の範囲で指定します。
戻り値(return)
数値
Date.prototype.setSeconds() メソッドは、指定された秒数を設定した後の、Date オブジェクトのミリ秒単位でのエポックタイム(1970年1月1日午前0時からの経過ミリ秒数)を数値で返します。