【JavaScript ECMAScript】Date::Date.prototype.setFullYearインスタンスメソッドの使い方
Date.prototype.setFullYear()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Date.prototype.setFullYear()メソッドは、JavaScriptのDateオブジェクトの年を設定するメソッドです。このメソッドは、Dateオブジェクトのインスタンスに対して呼び出され、指定された年の値を設定するために利用されます。
このメソッドには、主に三つの引数を指定できます。最初の引数であるyearValueは必須で、設定したい年を西暦の数値で指定します。例えば、2024年を設定するには2024と指定します。二番目の引数であるmonthValueは省略可能で、0から11までの数値で月を指定します(0が1月、11が12月を表します)。この引数を省略した場合、Dateオブジェクトに現在設定されている月の値がそのまま維持されます。三番目の引数であるdateValueも省略可能で、1から31までの数値で日を指定します。これも省略された場合、Dateオブジェクトに現在設定されている日の値が使われます。
指定された引数の値が一般的な範囲(例:月が0〜11、日が1〜31)を超えている場合でも、このメソッドは日付を自動的に調整してくれます。例えば、monthValueに12(13月)を指定すると、自動的に翌年の1月として扱われます。
このメソッドを実行すると、対象のDateオブジェクトの年、場合によっては月や日も直接変更されます。変更後には、1970年1月1日0時0分0秒UTCからの経過ミリ秒数を表す数値が戻り値として返されます。これは、Dateオブジェクトが正常に更新されたことを示すタイムスタンプです。Dateオブジェクトの日付を柔軟に操作する上で非常に重要なメソッドです。
構文(syntax)
1const date = new Date(); 2date.setFullYear(2024, 0, 1);
引数(parameters)
yearValue, monthValue = undefined, dateValue = undefined
- yearValue: number: 設定する西暦年を表す整数
- monthValue = undefined: number: 設定する月を表す整数 (0から11、省略時は現在の月)
- dateValue = undefined: number: 設定する日を表す整数 (1から31、省略時は現在の日)
戻り値(return)
Number
Date.prototype.setFullYear() メソッドは、Dateオブジェクトの年を設定し、それによって変更されたDateオブジェクトのUTC(協定世界時)でのミリ秒単位の表現(エポックからの経過時間)を返します。