【JavaScript ECMAScript】Array::Array.prototype.unshiftインスタンスメソッドの使い方

Array.prototype.unshift()メソッドは、指定された一つまたは複数の要素を配列の先頭に追加し、その結果として更新された配列の新しい長さ（要素数）を返すメソッドです。このメソッドは、呼び出し元の配列そのものを変更（ミューテーション）します。つまり、新しい配列を作成するのではなく、既存の配列の先頭に要素を挿入し、元々配列内に存在していた要素は、それぞれのインデックスが一つずつ後方に移動します。

引数には、配列の先頭に追加したい要素を複数指定することができます。これらの要素は、引数として渡された順序で配列の先頭に挿入されます。例えば、array.unshift(element1, element2)と実行すると、element1が最も先頭になり、次にelement2が続く形になります。メソッドの戻り値は、すべての要素が追加された後の配列の新しい要素の総数、すなわちlengthプロパティの値です。

このメソッドを使用すると、既存の配列に対して効率的に新しいデータを先頭に追加できます。しかし、配列の先頭に要素を追加する操作は、既存のすべての要素のインデックスを再計算し、メモリ上で移動させる必要があるため、特に非常に大きな配列に対して頻繁にこの操作を行うと、処理速度（パフォーマンス）に影響を与える可能性があります。そのため、配列操作の際には、用途や配列のサイズを考慮して、適切なメソッドを選択することが重要です。

Copy
1const arrayName = [2, 3];
2const newLength = arrayName.unshift(1);
3// arrayName は [1, 2, 3] になります
4// newLength は 3 になります

...elements

• ...elements: 配列の先頭に追加する要素。カンマ区切りで複数指定可能です。

数値

配列の先頭に1つ以上の要素を追加した後の、配列の新しい長さを返します。