The splice()
method of Array
instances changes the contents of an array by removing or replacing existing elements and/or adding new elements in place.
To create a new array with a segment removed and/or replaced without mutating the original array, use toSpliced()
. To access part of an array without modifying it, see slice()
.
Syntax
splice(start)
splice(start, deleteCount)
splice(start, deleteCount, item1)
splice(start, deleteCount, item1, item2)
splice(start, deleteCount, item1, item2, itemN)
Parameters
-
start
-
Zero-based index at which to start changing the array, converted to an integer.
- Negative index counts back from the end of the array — if
start < 0
, start + array.length
is used.
- If
start < -array.length
, 0
is used.
- If
start >= array.length
, no element will be deleted, but the method will behave as an adding function, adding as many elements as provided.
- If
start
is omitted (and splice()
is called with no arguments), nothing is deleted. This is different from passing undefined
, which is converted to 0
.
deleteCount
Optional
-
An integer indicating the number of elements in the array to remove from start
.
If deleteCount
is omitted, or if its value is greater than or equal to the number of elements after the position specified by start
, then all the elements from start
to the end of the array will be deleted. However, if you wish to pass any itemN
parameter, you should pass Infinity
as deleteCount
to delete all elements after start
, because an explicit undefined
gets converted to 0
.
If deleteCount
is 0
or negative, no elements are removed. In this case, you should specify at least one new element (see below).
item1
, …, itemN
Optional
-
The elements to add to the array, beginning from start
.
If you do not specify any elements, splice()
will only remove elements from the array.
Return value
An array containing the deleted elements.
If only one element is removed, an array of one element is returned.
If no elements are removed, an empty array is returned.
Description
The splice()
method is a mutating method. It may change the content of this
. If the specified number of elements to insert differs from the number of elements being removed, the array's length
will be changed as well. At the same time, it uses @@species
to create a new array instance to be returned.
If the deleted portion is sparse, the array returned by splice()
is sparse as well, with those corresponding indices being empty slots.
The splice()
method is generic. It only expects the this
value to have a length
property and integer-keyed properties. Although strings are also array-like, this method is not suitable to be applied on them, as strings are immutable.
Remove 0 (zero) elements before index 2, and insert "drum"
const myFish = ["angel", "clown", "mandarin", "sturgeon"];
const removed = myFish.splice(2, 0, "drum");
Remove 0 (zero) elements before index 2, and insert "drum" and "guitar"
const myFish = ["angel", "clown", "mandarin", "sturgeon"];
const removed = myFish.splice(2, 0, "drum", "guitar");
Remove 1 element at index 3
const myFish = ["angel", "clown", "drum", "mandarin", "sturgeon"];
const removed = myFish.splice(3, 1);
Remove 1 element at index 2, and insert "trumpet"
const myFish = ["angel", "clown", "drum", "sturgeon"];
const removed = myFish.splice(2, 1, "trumpet");
Remove 2 elements from index 0, and insert "parrot", "anemone" and "blue"
const myFish = ["angel", "clown", "trumpet", "sturgeon"];
const removed = myFish.splice(0, 2, "parrot", "anemone", "blue");
Remove 2 elements, starting from index 2
const myFish = ["parrot", "anemone", "blue", "trumpet", "sturgeon"];
const removed = myFish.splice(2, 2);
Remove 1 element from index -2
const myFish = ["angel", "clown", "mandarin", "sturgeon"];
const removed = myFish.splice(-2, 1);
Remove all elements, starting from index 2
const myFish = ["angel", "clown", "mandarin", "sturgeon"];
const removed = myFish.splice(2);
Using splice() on sparse arrays
The splice()
method preserves the array's sparseness.
const arr = [1, , 3, 4, , 6];
console.log(arr.splice(1, 2));
console.log(arr);
Calling splice() on non-array objects
The splice()
method reads the length
property of this
. It then updates the integer-keyed properties and the length
property as needed.
const arrayLike = {
length: 3,
unrelated: "foo",
0: 5,
2: 4,
};
console.log(Array.prototype.splice.call(arrayLike, 0, 1, 2, 3));
console.log(arrayLike);
Specifications
Browser compatibility
|
Desktop |
Mobile |
Server |
|
Chrome |
Edge |
Firefox |
Opera |
Safari |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
WebView Android |
Deno |
Node.js |
splice |
1 |
12 |
1 |
4 |
1 |
18 |
4 |
10.1 |
1 |
1.0 |
4.4 |
1.0 |
0.10.0 |