O'Reilly

Remove an Item From an Array with JavaScript

By on  

One operation that seems to be more difficult than it should be in every programming language is removing a value from an array.  It's such an easy concept mentally that it skews our programmatic view of the task.  In JavaScript the splice method is of huge help in removing an item from an array.

JavaScript Splice

One splice coupled with an indexOf removes the item from an array:

// Start with an initial array
var array = ["a", "b", "c"];

// Find and remove item from an array
var i = array.indexOf("b");
if(i != -1) {
	array.splice(i, 1);
}

Of course if you'd like to remove multiple occurrences of the same string/number, you'll need add a bit more logic:

for(var i = array.length-1; i--;){
	if (array[i] === "b") array.splice(i, 1);
}

You may be thinking that the filter method would work...

array.filter(function(i) {
	return i != "b"
});

...but that will return a new array, thus not modifying the original.

Removing a given value from an array isn't too difficult of a task when you have a reliable snippet nearby!

Track.js Error Reporting

Recent Features

  • Chris Coyier’s Favorite CodePen Demos

    David asked me if I'd be up for a guest post picking out some of my favorite Pens from CodePen. A daunting task! There are so many! I managed to pick a few though that have blown me away over the past few months. If you...

  • 5 Awesome New Mozilla Technologies You’ve Never Heard Of

    My trip to Mozilla Summit 2013 was incredible.  I've spent so much time focusing on my project that I had lost sight of all of the great work Mozillians were putting out.  MozSummit provided the perfect reminder of how brilliant my colleagues are and how much...

Incredible Demos

  • :valid, :invalid, and :required CSS Pseudo Classes

    Let's be honest, form validation with JavaScript can be a real bitch.  On a real basic level, however, it's not that bad.  HTML5 has jumped in to some extent, providing a few attributes to allow us to mark fields as required or only valid if matching...

  • Fade Images with MooTools LazyLoad

    I recently received an email from a MooTools developer asking a great question about my LazyLoad class: "I'm using your LazyLoad MooTools plugin (which is great, by the way). I have been trying to figure out how to modify it so that once an image scrolls into...

Discussion

  1. It’s important to note that splicing an array is an incredibly slow operation and is very difficult or impossible for engines to optimize. If you have performance sensitive uses of collections of items that need to be mutated at arbitrary points then you’ll likely want to look into alternative data structure implementations. Two new ones being introduced as base language features in ES6 are Map and Set, which force uniqueness but also allow for linear time item deletions. While these features only exist in Spidermonkey and V8 behind a flag, there are shims available and they will eventually be in all engines.

    • Awesome tip Brandon, thank you!

    • Oops, quick correction. That’s *constant* time, not *linear* time.

  2. Steve Fink

    nit: you start out looking past the end of the array. I think you want array.length-1.

    I haven’t benchmarked, but if you’re expecting to remove a lot of elements, it might be faster to do something like:

    for (var i = 0, j = 0; i < array.length; i++) {
    if (array[i] != "b")
    array[j++] = array[i];
    }
    array.length = j;

    • MaxArt

      I don’t know how much is “a lot” of elements, but your code (although nice) doesn’t seem to be very fast… At least, not faster than .splice:
      http://jsperf.com/removing-items-from-array
      In this case I’m just trying to remove 10% of the elements, maybe with a higher ratio the scenario would be different.

    • David

      @MaxArt: Your code has a little mistake: Instead of checking for b!==5, your should check for b[i]!==5. Otherwise, you just get “Array” for b, which is always false. Without this little mistake, Steve’s code is way faster.

    • I’m quite surprised by those results, Steve’s version should be faster than shifting all elements back one index each splice. I guess splice must have a clever implementation in the other browsers and Firefox 21 just has a beast JS interpreter :P

  3. indexOf doesn’t work on array in IE :(

    • MaxArt

      It does in IE9+.
      For IE8- there are common shims, but I guess you already know that.

  4. Al Jey

    Even though filter does in fact return a new array, it is a much more efficient way to get rid of multiple items at once than a several calls to splice, and as such should be preferred.

  5. Hey everyone, I’m new to contributing but stoked on javascript and the open source community so here I go.

    If you’re not concerned about keeping the array organized I came up with this which is blazing fast in comparison:
    if (i > 0)
    callbacks[i] = callbacks[0];
    callbacks.shift();

    Otherwise you will need to run a loop to shift all elements after the one you want to remove -1 index which depending on the size of the array could get ridiculous but in the majority of case would still crush splice.

    Let me know what you think or send me an email. I’m just getting started on Git to get more involved.

    • I was curious about your technique so I built a jsPerf test around it. Unfortunately, it appears array.splice still performs better than the method you described.

      http://jsperf.com/array-splice-vs-reassign-and-shift

      It was certainly a good idea and comes close to splice (except in FF), but since it destroys the ordering of the array, adds an extra line of code, and still doesn’t match splice, I’d recommend sticking with splice.

      I haven’t looked into the browser implementation code for splice. Maybe that’s something you would want to do to find if you can help optimize it further; otherwise, it might help you understand how arrays work behind-the-scenes.

  6. Hello David,
    I am new to java script and starting to learn about arrays. I understand pop and push. I would like to know how to use the splice code snippet you have posted. How would I use the splice code in my java script file?

    // tasks.js #2
    // This script manages a to-do list.
    
    // Need a global variable:
    var tasks = []; 
    
    // Function called when the form is submitted.
    // Function adds a task to the global array.
    function addTask() {
        'use strict';
    
        // Get the task:
        var task = document.getElementById('task');
    
        // Reference to where the output goes:
        var output = document.getElementById('output');
        
        // For the output:
        var message = '';
    
        if (task.value) {
        
            // Add the item to the array:
            tasks.push(task.value);
            
            // Update the page:
            message = 'To-Do';
            for (var i = 0, count = tasks.length; i < count; i++) {
                message += '' + tasks[i] + '';
            }
            message += '';
            output.innerHTML = message;
            
        } // End of task.value IF.
    
        // Return false to prevent submission:
        return false;
        
    } // End of addTask() function.
    
    // Initial setup:
    function init() {
        'use strict';
        document.getElementById('theForm').onsubmit = addTask;
    } // End of init() function.
    window.onload = init;
    
  7. Hey guys, I’m okay with js but still learning. I’ve been looking everywhere on how to time a function to END after a certain period of time, say two days. Any help? Would really appreciate any advice! Thanks in advance.

  8. Chirag64

    Your for loop for removing multiple occurrences of the same string/number is wrong. It doesn’t have any condition like i > -1;. Although it still seems to work, it doesn’t really check the last element of the array. So if you had an array like

    var array = ["a", "c", "b"];
    

    , it wouldn’t remove the ‘b’ element.

  9. Hey you have explained it very well but will it work if there is same value in array. i mean if duplicate data then what it will do. ?

    in my case i want to delete on the bases of key so what can i do ?
    please can you suggest me some solution.

  10. Timmah

    When you do this:

    for(var i = array.length-1; i--;){
    	if (array[i] === "b") array.splice(i, 1);
    }
    
    and array = ["a", "b", "b", "c", "d"];
    

    since splice re-indexes the array, won’t you miss the second “b”?

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!

Recently on David Walsh Blog

  • OSCON Portland:  Conference  Discount!

    O'Reilly puts on the best web industry conferences in the world.  These conferences include Fluent Conference, Velocity Conference, and the upcoming OSCON in Portland, Oregon from July 20-24.  Open Source Convention (OSCON) is a conference that focuses specifically on open source developers and the tools and possibilities...

  • Follow Redirects with cURL

    I love playing around with cURL. There's something about loading websites via command line that makes me feel like some type of smug hacker, just like tweeting from command line does. I recently cURL'd the Google homepage and saw the following: I found it weird that Google...

  • Developers Have WordPress, Amateurs Have Squarespace, Professional Designers Have the NEW Webydo!

    Web design platforms have traditionally come in one of two varieties. There are the solutions like WordPress and Drupal that are incredibly powerful, but an understanding of web development and coding is required to be able to use those platforms effectively. On the other side of the...

  • Chris Coyierâs Favorite CodePen Demos II

    Hey everyone! Before we get started, I just want to say it’s damn hard to pick this few favorites on CodePen. Not because, as a co-founder of CodePen, I feel like a dad picking which kid he likes best (RUDE). But because there is just so...

  • GSAP + SVG For Power Users: Motion Along A Path

    Now that the GreenSock API is picking up steam, there are many tutorials and Getting Started guides out there to provide good introductions to the library, not to mention GreenSock’s own Forum and Documentation. This article isn’t intended for beginners, but rather a...