What does an array splice do

The method changes the contents of an array by removing or replacing existing elements and/or adding new elements in place.

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

Syntax

let = .splice([, [, [, [, ...]]]])

Parameters

The index at which to start changing the array.
If greater than the length of the array, will be set to the length of the array.
If negative, it will begin that many elements from the end of the array. (In this case, the origin , meaning is the index of the th last element, and is therefore equivalent to the index of .)
If is less than , it will begin from index .
Optional
An integer indicating the number of elements in the array to remove from .
If is omitted, or if its value is equal to or larger than (that is, if it is equal to or greater than the number of elements left in the array, starting at ), then all the elements from to the end of the array will be deleted.

Note: In IE8, it won't delete all when is omitted.

If is or negative, no elements are removed. In this case, you should specify at least one new element (see below).
Optional
The elements to add to the array, beginning from . If you do not specify any elements, 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

If the specified number of elements to insert differs from the number of elements being removed, the array's will be different at the end of the call.

Examples

Remove 0 (zero) elements from index 2, and insert "drum"

let myFish = ['angel', 'clown', 'mandarin', 'sturgeon'] let removed = myFish.splice(2, 0, 'drum') // myFish is ["angel", "clown", "drum", "mandarin", "sturgeon"] // removed is [], no elements removed

Remove 0 (zero) elements from index 2, and insert "drum" and "guitar"

let myFish = ['angel', 'clown', 'mandarin', 'sturgeon'] let removed = myFish.splice(2, 0, 'drum', 'guitar') // myFish is ["angel", "clown", "drum", "guitar", "mandarin", "sturgeon"] // removed is [], no elements removed

Remove 1 element from index 3

let myFish = ['angel', 'clown', 'drum', 'mandarin', 'sturgeon'] let removed = myFish.splice(3, 1) // removed is ["mandarin"] // myFish is ["angel", "clown", "drum", "sturgeon"]

Remove 1 element from index 2, and insert "trumpet"

let myFish = ['angel', 'clown', 'drum', 'sturgeon'] let removed = myFish.splice(2, 1, 'trumpet') // myFish is ["angel", "clown", "trumpet", "sturgeon"] // removed is ["drum"]

Remove 2 elements from index 0, and insert "parrot", "anemone" and "blue"

let myFish = ['angel', 'clown', 'trumpet', 'sturgeon'] let removed = myFish.splice(0, 2, 'parrot', 'anemone', 'blue') // myFish is ["parrot", "anemone", "blue", "trumpet", "sturgeon"] // removed is ["angel", "clown"]

Remove 2 elements from index 2

let myFish = ['parrot', 'anemone', 'blue', 'trumpet', 'sturgeon'] let removed = myFish.splice(2, 2) // myFish is ["parrot", "anemone", "sturgeon"] // removed is ["blue", "trumpet"]

Remove 1 element from index -2

let myFish = ['angel', 'clown', 'mandarin', 'sturgeon'] let removed = myFish.splice(-2, 1) // myFish is ["angel", "clown", "sturgeon"] // removed is ["mandarin"]

Remove all elements after index 2 (incl.)

let myFish = ['angel', 'clown', 'mandarin', 'sturgeon'] let removed = myFish.splice(2) // myFish is ["angel", "clown"] // removed is ["mandarin", "sturgeon"]

Specifications

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub
DesktopMobileServer
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
ChromeFull support 1EdgeFull support 12FirefoxFull support 1IEFull support 5.5

Notes

Full support 5.5

Notes

Notes From Internet Explorer 5.5 through 8, all elements of the array will not be deleted if is omitted. This behavior was fixed in Internet Explorer 9.
OperaFull support YesSafariFull support 1WebView AndroidFull support YesChrome AndroidFull support 18Firefox AndroidFull support 4Opera AndroidFull support YesSafari iOSFull support 1Samsung Internet AndroidFull support YesnodejsFull support Yes

Legend

Full support
Full support
See implementation notes.
See implementation notes.

See also

  • / — add/remove elements from the end of the array
  • / — add/remove elements from the beginning of the array
  • — returns a new array comprised of this array joined with other array(s) and/or value(s)