Date.prototype.setFullYear()
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
setFullYear() は Date インスタンスのメソッドで、現地時間に基づき、指定された日時の「年」を設定します。新しいタイムスタンプを返します。
試してみましょう
const event = new Date("August 19, 1975 23:15:30");
event.setFullYear(1969);
console.log(event.getFullYear());
// 予想される結果: 1969
event.setFullYear(0);
console.log(event.getFullYear());
// 予想される結果: 0
構文
setFullYear(yearValue)
setFullYear(yearValue, monthValue)
setFullYear(yearValue, monthValue, dateValue)
引数
yearValue-
「年」の数字を指定する整数値。例えば、1995。
monthValue省略可-
任意。1 月から 12 月を表す 0 から 11 までの間の整数値。
dateValue省略可-
「日」を表す 1 から 31 までの間の整数値。
dateValue引数を指定した場合、monthValueも指定しなければなりません。
返値
その場で Date オブジェクトを変更し、新しいタイムスタンプを返します。引数が NaN (または undefined など、 NaN に変換されるその他の値)の場合、日付は無効な日時に設定され、 NaN が返されます。
解説
monthValue 引数と dateValue 引数を指定しない場合、 getMonth() メソッドと getDate() メソッドから返される値が使われます。
指定した値が期待される日付の範囲外の場合、それに応じて setFullYear() が他の引数と Date オブジェクトの日付情報の更新を試みます。例えば、monthValue に 15 を指定した場合、年に 1 が加算 (yearValue + 1) され、月が 3 になります。
setFullYear() は現地時間を基に動作するため、夏時間 (DST) の境界を越えると、予想外の経過時間が算出されることがあります。例えば、日付の設定によって「春の移行期間(1 時間遅れる)」を跨ぐ場合、新しい日付と古い日付のタイムスタンプの差は、名目上の日数の差に24時間を掛けた値よりも 1 時間少なくなります。逆に、夏時間終了(1 時間進む)の移行期間を越えた場合は、1 時間分多く加算されます。日付を一定の時間分調整する必要がある場合は、setUTCFullYear() または setTime() を考えてみることを検討してください。
新しい現地時刻がオフセットの移行期間内に該当する場合、正確な時刻は Temporal の disambiguation: "compatible" オプションと同じ動作を使用して算出されます。つまり、現地時刻が 2 つの瞬間に該当する場合は、より早い方が選択されます。現地時刻が存在しない場合(ギャップがある場合)、ギャップの期間分だけ先へ進みます。
例
>setFullYear() の使用
const theBigDay = new Date();
theBigDay.setFullYear(1997);
仕様書
| 仕様書 |
|---|
| ECMAScript® 2027 Language Specification> # sec-date.prototype.setfullyear> |