Blog>
Snippets

Avoiding Memory Leaks in Closures

Demonstrate potential memory leaks caused by closures, especially within loops, showing good and bad practices, and how to avoid retaining unnecessary references in closure scopes.
// BAD PRACTICE: Creating a memory leak with closures in a loop
for (var i = 0; i < 10; i++) {
    // Each DOM element references the `element` variable which retains a scope that includes `bigObject`
    var element = document.createElement('div');
    var bigObject = new Array(1000).fill(new Object());
    element.onclick = (function(e) {
        return function() {
            console.log('Element clicked:', e);
        };
    })(element);
    document.body.appendChild(element);
}
This code snippet demonstrates a bad practice that may lead to memory leaks. A new `div` element is created in each iteration of the loop, and bigObject is created but never used. A new function is created for each element's `onclick` event that has a closure over `bigObject` unnecessarily, which can lead to high memory usage if the object is large and the loop has many iterations.
// GOOD PRACTICE: Avoiding memory leaks by not retaining unnecessary references in closure scope
for (var i = 0; i < 10; i++) {
    // Create a new DOM element
    var element = document.createElement('div');

    // Set the onclick handler without a closure that might cause a memory leak
    element.onclick = function() {
        console.log('Element clicked:', this);
    };

    // Append the new element to the body
    document.body.appendChild(element);
}
In this improved code snippet, we create a DOM element and set the `onclick` event handler without creating a closure that unnecessarily captures the surrounding local variables. The `this` keyword is used to access the clicked element, which avoids retaining unnecessary references and prevents potential memory leaks associated with closures in loops.
// ANOTHER PRACTICE: Using modern JavaScript (ES6) features to avoid memory leaks
for (let i = 0; i < 10; i++) {
    let element = document.createElement('div'); // `let` will scope `element` to the block
    element.onclick = function() {
        console.log('Element clicked:', this);
    };
    document.body.appendChild(element);
}
Here we are using block-scoped `let` instead of `var` to ensure that each iteration of the loop has its own scope. This prevents any functions inside the loop from capturing large objects that don't need to be retained after the loop executes. Using `let` helps prevent memory leaks that can occur when using closures in loops.