【JavaScript ECMAScript】Array::Array.prototype.spliceインスタンスメソッドの使い方
Array.prototype.splice()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
Array.prototype.splice()メソッドは、JavaScriptのArrayオブジェクトに属し、配列の内容を柔軟に変更(削除、追加、置き換え)するメソッドです。このメソッドは、指定した開始位置から特定の数の要素を削除し、必要であればその削除した位置に新しい要素を追加することができます。元の配列自体を直接変更する「破壊的」な操作を行う点が特徴です。
第一引数には、変更を開始する配列のインデックスを指定します。配列の先頭は0から数えます。第二引数には、その開始インデックスから何個の要素を削除するかを数値で指定します。この第二引数を0に設定すると要素は削除されず、指定した位置に要素の挿入のみが行われます。第二引数を省略した場合は、開始インデックスから配列の最後まで全ての要素が削除されます。第三引数以降には、削除された位置に新しく追加したい要素を任意で複数指定できます。
メソッドの実行後には、元の配列から削除された要素を含む新しい配列が返されます。もし何も要素が削除されなかった場合は、空の配列が返されます。Array.prototype.splice()は、配列の一部を切り取ったり、新しい要素を挿入したり、既存の要素を別の要素で置き換えたりする際に、非常に強力なツールとして利用されます。
公式リファレンス: Array.prototype.splice()
構文(syntax)
1const myArray = ['apple', 'banana', 'cherry', 'date']; 2myArray.splice(1, 2, 'grape', 'kiwi');
引数(parameters)
start, deleteCount, ...items
- start: number: 配列を変更する開始位置を示す数値。負の値の場合、配列の末尾からのオフセットとして扱われます。
- deleteCount: number: startから削除する要素の数を示す数値。省略された場合、start以降の全ての要素が削除されます。
- items: any: startの位置に挿入する要素。複数指定可能です。
戻り値(return)
Array
Array.prototype.splice() メソッドは、配列から要素を削除したり、新しい要素を追加したりします。このメソッドの戻り値は、配列から削除された要素を格納した新しい配列です。