【Node.js24.x】Array::splice()メソッドの使い方
spliceメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
spliceメソッドは、配列の要素を削除したり、新しい要素を追加したり、あるいは既存の要素を新しい要素で置き換えたりすることで、配列の内容を直接変更するメソッドです。これは、JavaScriptの組み込みオブジェクトであるArrayクラスに属しており、非常に柔軟な配列操作を可能にします。
このメソッドは、変更を開始する位置を示すstartインデックス、削除する要素の数を指定するdeleteCount、そして追加したい任意の要素を引数として受け取ります。startが負の値の場合、配列の末尾からのオフセットとして扱われます。例えば、-1は最後の要素を指します。deleteCountに0を指定すると要素は削除されず、指定した位置に要素を追加する目的で使用できます。また、deleteCountを省略した場合、startインデックスから配列の末尾まですべての要素が削除されます。
spliceメソッドの大きな特徴は、呼び出された元の配列そのものを変更する「破壊的な」操作である点です。変更後の新しい配列を返すのではなく、元の配列が直接更新されます。そして、このメソッドは削除された要素を新しい配列として返します。もし何も削除されなかった場合は、空の配列を返します。特定の範囲の要素を削除したり、特定の場所に複数の要素を挿入したり、あるいは既存の要素を別の要素に置き換えたりする際に便利に活用できます。
構文(syntax)
1const arr = ['a', 'b', 'c', 'd', 'e']; 2arr.splice(1, 2, 'x', 'y');
引数(parameters)
start, deleteCount, ...items
- start: number: 配列の変更を開始するインデックス。負の値の場合は、配列の末尾からのオフセットとして解釈されます。
- deleteCount: number: 削除する要素の数。省略された場合、または
startから配列の末尾までの要素数よりも大きい場合、start以降のすべての要素が削除されます。 - items: any[]: (オプション) 配列に追加する要素。
戻り値(return)
Array
spliceメソッドは、元の配列から削除された要素を新しい配列として返します。