Short circuit Array.forEach like calling break

Asked 2023-09-20 20:55:31 View 297,244
[1,2,3].forEach(function(el) {
    if(el === 1) break;
});

How can I do this using the new forEach method in JavaScript? I've tried return;, return false; and break. break crashes and return does nothing but continue iteration.

  • It is worth noting that while return does indeed continue the iteration, it will skip any code that comes after it in the block. Take this code for instance: [1,2,3].forEach(function(el) { if(el === 2) { console.log(`Match on 2!`); return; } console.log(el); }); .The console.log(el); will be skipped when 2 is matched. - anyone

Answers

There's no built-in ability to break in forEach. To interrupt execution you would have to throw an exception of some sort. eg.

var BreakException = {};

try {
  [1, 2, 3].forEach(function(el) {
    console.log(el);
    if (el === 2) throw BreakException;
  });
} catch (e) {
  if (e !== BreakException) throw e;
}

JavaScript exceptions aren't terribly pretty. A traditional for loop might be more appropriate if you really need to break inside it.

Use Array#some

Instead, use Array#some:

[1, 2, 3].some(function(el) {
  console.log(el);
  return el === 2;
});

This works because some returns true as soon as any of the callbacks, executed in array order, return true, short-circuiting the execution of the rest.

some, its inverse every (which will stop on a return false), and forEach are all ECMAScript Fifth Edition methods which will need to be added to the Array.prototype on browsers where they're missing.

Use Array#every

[1, 2, 3].every(v => {
  if (v > 2) {
    return false // "break"
  }
  console.log(v);
  return true // must return true if doesn't break
});

Answered   2023-09-20 20:55:31

  • You can also try to use ECMAScript2015 new for...of (developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/…) which would do exactly what you are looking for but the drawback is that this solution can cause issues for older browsers. If you are looking for more generic solution that support more than just array, you could look at solution like this (github.com/nbouvrette/forEach) one who can solve all your problems if you are willing to go this route. - anyone
  • The use of Array#some is really nice. Firstly its compatible with most browsers including ie9 and firefox 1.5 also works really well. My example use case will be to find the index in an array of ranges[a,b] where a number is between a lower boundary and upper boundary pair, test and return true when found. for..of would be the next best solution though only for newer browsers. - anyone
  • Exception handling should NEVER be used as control flow. PERIOD. - anyone
  • @frank I wrote an esolang with only one loop construct: forever. All other loop constructs are formed from forever and appropriate iterable exceptions, such as ContinueIteration and StopIteration (which break is a macro to raise). On one hand: never. On the other hand: always. On the gripping hand: sometimes? The "PERIOD" in your comment implies there may be a citation to back up your suggestion? - anyone
  • @frank it depends on the language. In Python it is perfectly acceptable to control flow with exception handling. In fact, __next__() raises StopIteration after generator exhaustion for that reason, as it is generally the best way to detect the end of a generator - it's way better than relying on magic return values. Python's ducktyping and EAFP patterns generally depend on exception handling as a flow control mechanic. - anyone

There is now an even better way to do this in ECMAScript2015 (aka ES6) using the new for of loop. For example, this code does not print the array elements after the number 5:

const arr = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
for (const el of arr) {
  console.log(el);
  if (el === 5) {
    break;
  }
}

From the docs:

Both for...in and for...of statements iterate over something. The main difference between them is in what they iterate over. The for...in statement iterates over the enumerable properties of an object, in original insertion order. The for...of statement iterates over data that iterable object defines to be iterated over.

Need the index in the iteration? You can use Array.entries():

for (const [index, el] of arr.entries()) {
  if ( index === 5 ) break;
}

Answered   2023-09-20 20:55:31

  • @superhero You can get the index of the element in a for...of loop, you just have to use entries. for (const [index, element] of someArray.entries()) { // ... } - anyone
  • isn't it recommended not to use for...in with arrays ? - anyone
  • @emostafa You are correct about for in loops not being recommended for arrays, but this is approach actually uses a for of loop. - anyone
  • This is "for of", and this is a really clean solution... but this is also an ES6 feature, so just be aware that this will only work if your environment is setup for ES6. - anyone
  • I find myself using this solution a lot, and I use it for objects as well. With objects, you can do Object.entries(myObject) and then use it exactly like you use the for..in for the array. Note that JS arrays are basically objects under the hood: blog.niftysnippets.org/2011/01/myth-of-arrays.html - anyone

You can use every method:

[1,2,3].every(function(el) {
    return !(el === 1);
});

ES6

[1,2,3].every( el => el !== 1 )

for old browser support use:

if (!Array.prototype.every)
{
  Array.prototype.every = function(fun /*, thisp*/)
  {
    var len = this.length;
    if (typeof fun != "function")
      throw new TypeError();

    var thisp = arguments[1];
    for (var i = 0; i < len; i++)
    {
      if (i in this &&
          !fun.call(thisp, this[i], i, this))
        return false;
    }

    return true;
  };
}

more details here.

Answered   2023-09-20 20:55:31

  • Nice and clean in ES6 now - [1,2,3].every( el => el !== 1 ) - anyone
  • @Valdemar, But does every guarantee that calls are made in sequence? - anyone
  • @Pacerier, you can see the algorithm in the ES6 specification that the index k starts at 0 and is incremented by 1: http://www.ecma-international.org/ecma-262/6.0/#sec-array.prototype.every - anyone
  • @Pacerier, yes, most popular implementations work properly. If you are concerned about embedded implementations, usually it's Opera or webkit. Method every calls callbackfn once for each element present in the array, in ascending order, until it finds one where callbackfn returns false. Also look at step 7. Let k be 0. and 8.e Increase k by 1. - anyone
  • Changes the intention of the code. Very bad. - anyone

Quoting from the MDN documentation of Array.prototype.forEach():

There is no way to stop or break a forEach() loop other than by throwing an exception. If you need such behaviour, the .forEach() method is the wrong tool, use a plain loop instead. If you are testing the array elements for a predicate and need a boolean return value, you can use every() or some() instead.

For your code (in the question), as suggested by @bobince, use Array.prototype.some() instead. It suits very well to your usecase.

Array.prototype.some() executes the callback function once for each element present in the array until it finds one where callback returns a truthy value (a value that becomes true when converted to a Boolean). If such an element is found, some() immediately returns true. Otherwise, some() returns false. callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

Answered   2023-09-20 20:55:31

  • This is the correct answer. 'some' does exactly what a foreach/break would do. It loops until iteration n = true. - anyone
  • Sonar flags it, not using the returned value from array.some(). The logic is to use it only for looping. - anyone

Unfortunately in this case it will be much better if you don't use forEach. Instead use a regular for loop and it will now work exactly as you would expect.

var array = [1, 2, 3];
for (var i = 0; i < array.length; i++) {
  if (array[i] === 1){
    break;
  }
}

Answered   2023-09-20 20:55:31

  • It shocks me that the highest vote is the worst implementation possible, compared to the higher performing, less code, and better readability of this correct answer. Throw exception... really? Is the traditional for loop just not kewl enough? - anyone
  • @gdbj I agree with your statement and used this method, but what really shocks me is there is no way of exiting a forEach without these hacks, now that's bad design. - anyone
  • @gdbj I also agree, but the issue is more with Stack Overflow and its guidelines. The question specifically asks for a solution to break out of an Array.forEach loop. The accepted answer does that... in an incredibly ugly way. Technically this answer is incorrect, even though it achieves the same goal in a tried and true fashion. - anyone

From your code example, it looks like Array.prototype.find is what you are looking for: Array.prototype.find() and Array.prototype.findIndex()

[1, 2, 3].find(function(el) {
    return el === 2;
}); // returns 2

Answered   2023-09-20 20:55:31

Consider to use jquery's each method, since it allows to return false inside callback function:

$.each([{user: "barney", active: false}, {user: "fred", active: false}],function(e, i) { 
   if (i % 2) return false;
   console.log(e)
})

Lodash libraries also provides takeWhile method that can be chained with map/reduce/fold etc:

var users = [
  { 'user': 'barney',  'active': false },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': true }
];
 
_.takeWhile(users, function(o) { return !o.active; });
// => objects for ['barney', 'fred']
 
// The `_.matches` iteratee shorthand.
_.takeWhile(users, { 'user': 'barney', 'active': false });
// => objects for ['barney']
 
// The `_.matchesProperty` iteratee shorthand.
_.takeWhile(users, ['active', false]);
// => objects for ['barney', 'fred']
 
// The `_.property` iteratee shorthand.
_.takeWhile(users, 'active');
// => []

Answered   2023-09-20 20:55:31

  • Good reason to use jQuery. forEach in native javascript is still lacking. - anyone
  • @AlexGrande jQuery's forEach and JavaScript's forEach are not compatible. - anyone
  • JavaScript is used in many places that jQuery is not an option. - anyone
  • The jQuery code using each is incorrect. It takes an array and a callback. It should rather be something like: $.each(array,function(e, i) { if (i % 2) return false; console.log(e) }); See: jQuery documentation - anyone

If you would like to use Dean Edward's suggestion and throw the StopIteration error to break out of the loop without having to catch the error, you can use the following the function (originally from here):

// Use a closure to prevent the global namespace from be polluted.
(function() {
  // Define StopIteration as part of the global scope if it
  // isn't already defined.
  if(typeof StopIteration == "undefined") {
    StopIteration = new Error("StopIteration");
  }

  // The original version of Array.prototype.forEach.
  var oldForEach = Array.prototype.forEach;

  // If forEach actually exists, define forEach so you can
  // break out of it by throwing StopIteration.  Allow
  // other errors will be thrown as normal.
  if(oldForEach) {
    Array.prototype.forEach = function() {
      try {
        oldForEach.apply(this, [].slice.call(arguments, 0));
      }
      catch(e) {
        if(e !== StopIteration) {
          throw e;
        }
      }
    };
  }
})();

The above code will give you the ability to run code such as the following without having to do your own try-catch clauses:

// Show the contents until you get to "2".
[0,1,2,3,4].forEach(function(val) {
  if(val == 2)
    throw StopIteration;
  alert(val);
});

One important thing to remember is that this will only update the Array.prototype.forEach function if it already exists. If it doesn't exist already, it will not modify the it.

Answered   2023-09-20 20:55:31

Short answer: use for...break for this or change your code to avoid breaking of forEach. Do not use .some() or .every() to emulate for...break. Rewrite your code to avoid for...break loop, or use for...break. Every time you use these methods as for...break alternative God kills kitten.

Long answer:

.some() and .every() both return boolean value, .some() returns true if there any element for which passed function returns true, every returns false if there any element for which passed function returns false. This is what that functions mean. Using functions for what they doesn't mean is much worse then using tables for layout instead of CSS, because it frustrates everybody who reads your code.

Also, the only possible way to use these methods as for...break alternative is to make side-effects (change some vars outside of .some() callback function), and this is not much different from for...break.

So, using .some() or .every() as for...break loop alternative isn't free of side effects, this isn't much cleaner then for...break, this is frustrating, so this isn't better.

You can always rewrite your code so that there will be no need in for...break. You can filter array using .filter(), you can split array using .slice() and so on, then use .forEach() or .map() for that part of array.

Answered   2023-09-20 20:55:31

  • using .filter is actually the appropriate solution for a lot of use cases for breaking. - anyone
  • What about performance? Woudln't filter affect performance if used frequently? - anyone
  • Yes, the filter array prototype can get heavy. I love it, but it could effect performance if it's overused. - anyone
  • @tfrascaroli use for...break loop if you need performance. for loop is the most performant iteration tool than .forEach(), .any(), .map(), .filter() etc. - anyone
  • Why is using a table for layout a bad thing if you intend to build a table? Actually, not using a table when needing a table is just like using some, every instead of breaking. The table thing has nothing to do with readability. - anyone

As mentioned before, you can't break .forEach().

Here's a slightly more modern way of doing a foreach with ES6 Iterators. Allows you to get direct access to index/value when iterating.

const array = ['one', 'two', 'three'];

for (const [index, val] of array.entries()) {
  console.log('item:', { index, val });
  if (index === 1) {
    console.log('break!');
    break;
  }
}

Output:

item: { index: 0, val: 'one' }
item: { index: 1, val: 'two' }
break!

Links

Answered   2023-09-20 20:55:31

Another concept I came up with:

function forEach(array, cb) {
  var shouldBreak;
  function _break() { shouldBreak = true; }
  for (var i = 0, bound = array.length; i < bound; ++i) {
    if (shouldBreak) { break; }
    cb(array[i], i, array, _break);
  }
}

// Usage

forEach(['a','b','c','d','e','f'], function (char, i, array, _break) {
  console.log(i, char);
  if (i === 2) { _break(); }
});

Answered   2023-09-20 20:55:31

  • The syntax is similar to [NSArray enumerateObjectsUsingBlock], Thanks! - anyone
  • @Drenai the signature is analogous to the native Array.prototype.forEach(). for and break existed long before this question was asked; the OP was looking for that behaviour using, the more functional, forEach. - anyone
  • @Drenai has now deleted their comment (but left the downvote) which mentioned that the signature of this solution is hard to remember and unnecessary when you can solve the problem with for...in and break. - anyone

This is just something I came up with to solve the problem... I'm pretty sure it fixes the problem that the original asker had:

Array.prototype.each = function(callback){
    if(!callback) return false;
    for(var i=0; i<this.length; i++){
        if(callback(this[i], i) == false) break;
    }
};

And then you would call it by using:

var myarray = [1,2,3];
myarray.each(function(item, index){
    // do something with the item
    // if(item != somecondition) return false; 
});

Returning false inside the callback function will cause a break. Let me know if that doesn't actually work.

Answered   2023-09-20 20:55:31

  • === false might be better than == false so you don't have to explicitly return true (or a truthy value) to continue the loop, lest some control path doesn't return a value and the loop breaks unexpectedly. - anyone

If you don't need to access your array after iteration you can bail out by setting the array's length to 0. If you do still need it after your iteration you could clone it using slice..

[1,3,4,5,6,7,8,244,3,5,2].forEach(function (item, index, arr) {
  if (index === 3) arr.length = 0;
});

Or with a clone:

var x = [1,3,4,5,6,7,8,244,3,5,2];

x.slice().forEach(function (item, index, arr) {
  if (index === 3) arr.length = 0;
});

Which is a far better solution then throwing random errors in your code.

Answered   2023-09-20 20:55:31

  • well done :) but if there are some actions after assigning array.length to 0 they will apply in current iteration, so probably it's sometimes better to use return after such assigning - anyone

Found this solution on another site. You can wrap the forEach in a try / catch scenario.

if(typeof StopIteration == "undefined") {
 StopIteration = new Error("StopIteration");
}

try {
  [1,2,3].forEach(function(el){
    alert(el);
    if(el === 1) throw StopIteration;
  });
} catch(error) { if(error != StopIteration) throw error; }

More details here: http://dean.edwards.name/weblog/2006/07/enum/

Answered   2023-09-20 20:55:31

  • Don't use exceptions as a control flow statements. Use it for handling unexpected results. - anyone

This is a for loop, but maintains the object reference in the loop just like a forEach() but you can break out.

var arr = [1,2,3];
for (var i = 0, el; el = arr[i]; i++) {
    if(el === 1) break;
}

Answered   2023-09-20 20:55:31

try with "find" :

var myCategories = [
 {category: "start", name: "Start", color: "#AC193D"},
 {category: "action", name: "Action", color: "#8C0095"},
 {category: "exit", name: "Exit", color: "#008A00"}
];

function findCategory(category) {
  return myCategories.find(function(element) {
    return element.category === category;
  });
}

console.log(findCategory("start"));
// output: { category: "start", name: "Start", color: "#AC193D" }

Answered   2023-09-20 20:55:31

Yet another approach:

var wageType = types.filter(function(element){
  if(e.params.data.text == element.name){
    return element;
  }
});
console.dir(wageType);

Answered   2023-09-20 20:55:31

  • Is this right usage of filter method? I guess callback returns a boolean that regardless of it, callback is called array elements until the last one. - anyone
  • The question says "short circuit", filter does not. - anyone

I use nullhack for that purpose, it tries to access property of null, which is an error:

try {
  [1,2,3,4,5]
  .forEach(
    function ( val, idx, arr ) {
      if ( val == 3 ) null.NULLBREAK;
    }
  );
} catch (e) {
  // e <=> TypeError: null has no properties
}
//

Answered   2023-09-20 20:55:31

  • Why not just throw BREAK? - anyone
  • You can simply use FOOBARED and it would throw an error. - anyone

Use the array.prototype.every function, which provide you the utility to break the looping. See example here Javascript documentation on Mozilla developer network

Answered   2023-09-20 20:55:31

Agree with @bobince, upvoted.

Also, FYI:

Prototype.js has something for this purpose:

<script type="text/javascript">
  $$('a').each(function(el, idx) {
    if ( /* break condition */ ) throw $break;
    // do something
  });
</script>

$break will be catched and handled by Prototype.js internally, breaking the "each" cycle but not generating external errors.

See Prototype.JS API for details.

jQuery also has a way, just return false in the handler to break the loop early:

<script type="text/javascript">
  jQuery('a').each( function(idx) {
    if ( /* break condition */ ) return false;
    // do something

  });
</script>

See jQuery API for details.

Answered   2023-09-20 20:55:31

If you want to keep your forEach syntax, this is a way to keep it efficient (although not as good as a regular for loop). Check immediately for a variable that knows if you want to break out of the loop.

This example uses a anonymous function for creating a function scope around the forEach which you need to store the done information.

(function(){
    var element = document.getElementById('printed-result');
    var done = false;
    [1,2,3,4].forEach(function(item){
        if(done){ return; }
        var text = document.createTextNode(item);
        element.appendChild(text);
        if (item === 2){
          done = true;
          return;
        }
    });
})();
<div id="printed-result"></div>

My two cents.

Answered   2023-09-20 20:55:31

If you need to break based on the value of elements that are already in your array as in your case (i.e. if break condition does not depend on run-time variable that may change after array is assigned its element values) you could also use combination of slice() and indexOf() as follows.

If you need to break when forEach reaches 'Apple' you can use

var fruits = ["Banana", "Orange", "Lemon", "Apple", "Mango"];
var fruitsToLoop = fruits.slice(0, fruits.indexOf("Apple"));
// fruitsToLoop = Banana,Orange,Lemon

fruitsToLoop.forEach(function(el) {
    // no need to break
});

As stated in W3Schools.com the slice() method returns the selected elements in an array, as a new array object. The original array will not be changed.

See it in JSFiddle

Hope it helps someone.

Answered   2023-09-20 20:55:31

Why don't you try wrapping the function in a Promise?

The only reason I bring it up is that I am using a function in an API that acts in a similar manner to forEach. I don't want it to keep iterating once it finds a value, and I need to return something so I am simply going to resolve a Promise and do it that way.

traverseTree(doc): Promise<any> {
  return new Promise<any>((resolve, reject) => {
    this.gridOptions.api.forEachNode((node, index) => {
    //the above function is the one I want to short circuit.
      if(node.data.id === doc.id) {
        return resolve(node);
      }
    });
  });
}

Then all you need to do is do something with the result like

this.traverseTree(doc).then((result) => {
   this.doSomething(result);
});

My above example is in typescript, simply ignore the types. The logic should hopefully help you "break" out of your loop.

Answered   2023-09-20 20:55:31

This isn't the most efficient, since you still cycle all the elements, but I thought it might be worth considering the very simple:

let keepGoing = true;
things.forEach( (thing) => {
  if (noMore) keepGoing = false;
  if (keepGoing) {
     // do things with thing
  }
});

Answered   2023-09-20 20:55:31

  • continue is a keyword, your code is a syntax error. - anyone
  • Given that you're using ES6 anyway, you should just switch to a for of loop and break; from that as usual. - anyone
  • fixed, and true -- but was mostly using es6 for brevity - anyone

you can follow the code below which works for me:

 var     loopStop = false;
YOUR_ARRAY.forEach(function loop(){
    if(loopStop){ return; }
    if(condition){ loopStop = true; }
});

Answered   2023-09-20 20:55:31

  • Why the -1? it isn't uglier than catching an exception, that is a bigger hack IMHO. - anyone

Breaking out of built-in Array.prototype.map function esp in React

The key thing to note here is the use of statement return to BREAK

let isBroken = false;

colours.map(item => {
    if (isBroken) {
        return;
    }
    if (item.startsWith("y")) {
        console.log("The yessiest colour!");
        isBroken = true;
        return;
    }
});

More information here: https://www.codegrepper.com/code-examples/javascript/break+out+of+map+javascript

Answered   2023-09-20 20:55:31

I know it not right way. It is not break the loop. It is a Jugad

let result = true;
[1, 2, 3].forEach(function(el) {
    if(result){
      console.log(el);
      if (el === 2){
        result = false;
      }
    }
});

Answered   2023-09-20 20:55:31

You can create a variant of forEach that allows for break, continue, return, and even async/await: (example written in TypeScript)

export type LoopControlOp = "break" | "continue" | ["return", any];
export type LoopFunc<T> = (value: T, index: number, array: T[])=>LoopControlOp;

Array.prototype.ForEach = function ForEach<T>(this: T[], func: LoopFunc<T>) {
    for (let i = 0; i < this.length; i++) {
        const controlOp = func(this[i], i, this);
        if (controlOp == "break") break;
        if (controlOp == "continue") continue;
        if (controlOp instanceof Array) return controlOp[1];
    }
};

// this variant lets you use async/await in the loop-func, with the loop "awaiting" for each entry
Array.prototype.ForEachAsync = async function ForEachAsync<T>(this: T[], func: LoopFunc<T>) {
    for (let i = 0; i < this.length; i++) {
        const controlOp = await func(this[i], i, this);
        if (controlOp == "break") break;
        if (controlOp == "continue") continue;
        if (controlOp instanceof Array) return controlOp[1];
    }
};

Usage:

function GetCoffee() {
    const cancelReason = peopleOnStreet.ForEach((person, index)=> {
        if (index == 0) return "continue";
        if (person.type == "friend") return "break";
        if (person.type == "boss") return ["return", "nevermind"];
    });
    if (cancelReason) console.log("Coffee canceled because: " + cancelReason);
}

Answered   2023-09-20 20:55:31

  • This would require anyone to get back and read the Array prototype which seems not trivial and a waste of time - anyone
  • No, the "continue", "break", and "return" strings/operators are processed within the ForEach function (it's not the generic forEach function) -- the caller does not need to read anything on the Array prototype. That said, I don't actually use the solution above in production code -- it's just showing how one could accomplish those various operators within a forEach-like function, if they wished to. - anyone
  • Yes. And still - if I would encounter this - it would not be clear at first look. - anyone

In fact, I don't understand the reward for this old question. But if you really want to interrupt the foreach cycle, using only the foreach cycle, you can use the second parameter of the method to save the original array after its zeroing. Something like this:

let array = [1, 2, 3];
array.forEach(function(el) {
    console.log(el);
    if(el === 1) {
        array = [...this];
        this.length = 0;
    }
}, array);
console.log(array);

P.S. I am in no way not advise that this should be done. On the contrary, I advise you to bypass my answer and use the previous best suggestions. Best regards.

Answered   2023-09-20 20:55:31

I use return false and it works for me.

Answered   2023-09-20 20:55:31