How to Exit, Stop, or Break an Array#forEach Loop in JavaScript or Node.js

Leaving a loop early is a common practice in programming. Stopping or breaking out of an Array#forEach iteration in JavaScript is only possible by throwing an exception.

Also, the Mozilla Developer Network states “when you need to stop forEach, it’s the wrong tool.

This tutorial points you to alternatives that exit early when meeting a condition.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js (Coming soon)
  27. Check if a String is Empty in JavaScript or Node.js (Coming soon)
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js (Coming soon)
  29. Left-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  30. Right-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  31. Lowercase the First Character of a String in JavaScript or Node.js (Coming soon)
  32. Uppercase the First Character of a String in JavaScript or Node.js (Coming soon)
  33. Prepend Characters or Words to a String in JavaScript or Node.js (Coming soon)

Exit a forEach Loop Early

When searching MDN for the Array#forEach method, you’ll find the following paragraph:

There is no way to stop or break a forEach() loop other than by throwing an exception. If you need such behavior, the forEach() method is the wrong tool.

Fair enough. What are alternatives?

The good news: you have a handful of other ways early exiting a loop:

In one of our projects, we decided to replace our Array#forEach statement using a for…of loop. This way, we are able to exit the loop early using a break statement.

Here are Two Examples

Imagine two virtualization hosts each running 15 virtual machines. The task is to consolidate as many VMs as possible on the second host. If the second host is missing any free capacity for more VMs, leave them on the first host.

Here are simplified sample code snippets using Array#forEach, Array#some, and a for…of loop. Each loop moves all VMs not running MySQL from the first host to the second one. The loop can stop as soon as the first host doesn’t run any VM with MySQL.

Using Array#some

Using Array#some allows you to iterate through the list of items until a condition evaluates to true. Related to the example above you can move as many VMs onto the second host until it’s full. Array#some stops iterating as soon as the condition secondHost.isFull() returns true:

firstHost.vms().some(vm => {  
  vm.moveTo(secondHost)

  return secondHost.isFull() // exits the loop if the second host is full
})

Using a for…of Loop

You may use a for…of loop instead of Array#forEach. You can exit a for…of loop using the break keyword. Then, JavaScript will break out of the loop:

for (vm of firstHost.vms()) {  
  vm.moveTo(secondHost)

  if (secondHost.isFull()) {
    break
  }
}

Find more details about exiting a for loop in JavaScript in a related tutorial here on Future Studio.

Sweet!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.