【Node.js24.x】Array::unshift()メソッドの使い方
unshiftメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
unshiftメソッドは、Arrayオブジェクトの先頭に一つ以上の要素を追加するメソッドです。このメソッドはJavaScriptの標準組み込みオブジェクトであるArrayのプロトタイプに定義されており、Node.jsのバージョン24を含む環境で利用できます。
具体的には、unshift()メソッドの引数として渡された要素が、元の配列の既存の要素よりも前に追加されます。複数の要素を引数として指定した場合、それらは指定された順序で配列の先頭に追加され、最初に渡された引数が配列の新しい最初の要素となります。
unshiftメソッドは、実行後に要素が追加された新しい配列の長さを数値として返します。このメソッドの特に重要な特性は、元の配列自体を直接変更する「破壊的メソッド」であるという点です。つまり、unshiftを呼び出すと、元の配列変数の内容は完全に書き換えられます。もし元の配列を変更せずに、先頭に要素を追加した新しい配列を作成したい場合は、スプレッド構文(...)などの別の方法を検討する必要があります。
構文(syntax)
const myArray = ['c', 'd'];
myArray.unshift('a', 'b');
引数(parameters)
...elements
- elements: any[]: 配列の先頭に追加したい要素。複数の要素をカンマ区切りで指定できます。
戻り値(return)
Number
配列の先頭に要素が追加された後の、配列の新しい長さを返します。