【Node.js24.x】Date::setUTCMonth()メソッドの使い方
setUTCMonthメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
setUTCMonthメソッドは、Node.jsのDateオブジェクトのインスタンスに対して、協定世界時(UTC)における月を設定するメソッドです。このメソッドを使用することで、既存のDateオブジェクトの月をプログラム的に変更できます。
このメソッドには、主に二つの引数を指定できます。最初の引数であるmonthValueは必須で、設定したい月を0から11までの整数で指定します。例えば、1月を設定したい場合は0を、12月を設定したい場合は11を指定します。もしmonthValueが11を超える値であった場合、自動的に年が調整されます。例えば、12を指定すると翌年の1月、13を指定すると翌年の2月として扱われ、年を跨いだ月設定が可能です。
二つ目の引数であるdayValueはオプションで、設定したい日付を1から31までの整数で指定します。この引数を省略した場合、Dateオブジェクトが現在保持しているUTCにおける日付(getUTCDate()メソッドで取得される値)がそのまま使用されます。もしdayValueが指定した月の最終日を超えるような値だった場合、monthValueと同様に、自動的に月や年が調整されて日付が算出されます。
setUTCMonthメソッドは、設定後のDateオブジェクトが持つ、1970年1月1日0時0分0秒UTCからの経過ミリ秒数を数値として返します。この戻り値は、日付設定が成功したことを示すタイムスタンプとして利用できます。このメソッドはDateオブジェクト自体の状態を直接変更するため、元のオブジェクトの内容が更新される点にご留意ください。
構文(syntax)
1const dateObj = new Date('2024-01-15T10:00:00Z'); 2dateObj.setUTCMonth(2, 10); // UTCで月を3月(インデックス2)に、日を10日に設定 3console.log(dateObj.toUTCString());
引数(parameters)
monthValue, dayValue
- monthValue: number: 設定するUTCの月を指定します。0(1月)から11(12月)の範囲で指定します。
- dayValue: number: 設定するUTCの日を指定します。省略した場合、現在の日の値が維持されます。
戻り値(return)
number
DateオブジェクトのUTC基準での月を設定し、設定後のミリ秒単位のタイムスタンプを返します。