【Node.js24.x】Array::copyWithin()メソッドの使い方
copyWithinメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
copyWithinメソッドは、配列内の要素を、同じ配列内の別の位置にコピーして上書きするメソッドです。このメソッドは、既存の配列の内容を直接変更します。
具体的には、第一引数 target には要素のコピーを開始する配列のインデックスを指定します。第二引数 start にはコピー元となる要素の範囲の開始インデックスを指定し、第三引数 end にはコピー元となる要素の範囲の終了インデックスを指定します。end で指定されたインデックスの要素はコピーの対象には含まれません。start を省略した場合、0番目のインデックスからコピーが開始され、end を省略した場合は配列の末尾までがコピー対象となります。これらのインデックスには、負の値を指定することも可能で、その場合は配列の末尾からの相対的な位置として扱われます。
copyWithin メソッドは元の配列を直接変更するため、新しい配列を作成して返すわけではありません。処理後、変更された配列自身が戻り値として返されます。このメソッドを使用することで、既存の配列の中で特定の部分を効率的に移動させたり、複製したりする操作を簡潔に記述できます。Node.js環境下で配列の要素の操作を行う際に活用できます。
構文(syntax)
1let arr = [1, 2, 3, 4, 5]; 2arr.copyWithin(0, 1, 3); // arr は [2, 3, 3, 4, 5] に変更される
引数(parameters)
target, start = 0, end = this.length
- target: number: コピーした要素を配置する開始位置のインデックス
- start: number = 0: コピー元の配列の開始位置のインデックス
- end: number = this.length: コピー元の配列の終了位置のインデックス (このインデックスの要素は含まれません)
戻り値(return)
Array
指定した範囲の配列要素を、指定した位置にコピーした配列を返します。