Array.prototype.unshift()

unshift() メソッドは、配列の最初に 1 つ以上の要素を追加し、新しい配列の長さを返します。

構文

arr.unshift(element1[, ...[, elementN]])

引数

elementN

配列の先頭に追加する要素。

戻り値

メソッドが呼び出し後の length プロパティの値

説明

unshift メソッドは与えられた要素を配列のようなオブジェクトの一番最初に挿入します。

unshift は意図して汎用的です。つまり、このメソッドは配列に類似したオブジェクトに対して called したり applied したりすることができます。ゼロから始まる数値プロパティであり、連続した連なりの最後を反映している length プロパティを含まないオブジェクトでは効果がないかもしれません。

例

var arr = [1, 2];

arr.unshift(0); // result of call is 3, the new array length
// arr is [0, 1, 2]

arr.unshift(-2, -1); // = 5
// arr is [-2, -1, 0, 1, 2]

arr.unshift([-3]);
// arr is [[-3], -2, -1, 0, 1, 2]

仕様

ブラウザ実装状況

関連情報

• Array.prototype.push()
• Array.prototype.pop()
• Array.prototype.shift()
• Array.prototype.concat()