Reputation: 6973

how to break the _.each function in underscore.js

I'm looking for a way to stop iterations of underscore.js _.each() method, but can't find the solution. jQuery .each() can break if you do return false.

Is there a way to stop underscore each()?

_([1,2,3]).each(function(v){
    if (v==2) return /*what?*/;
})

Upvotes: 206

Answers (11)

aleXela

Reputation: 1301

worked in my case

var arr2 = _.filter(arr, function(item){
    if ( item == 3 ) return item;
});

Upvotes: -1

Joan

Reputation: 303

You can have a look to _.some instead of _.each. _.some stops traversing the list once a predicate is true. Result(s) can be stored in an external variable.

_.some([1, 2, 3], function(v) {
    if (v == 2) return true;
})

See http://underscorejs.org/#some

Upvotes: 17

aeskr

Reputation: 3436

You can't break from the each method—it emulates the native forEach method's behavior, and the native forEach doesn't provide to escape the loop (other than throwing an exception).

However, all hope is not lost! You can use the Array.every method. :)

From that link:

every executes the provided callback function once for each element present in the array until it finds one where callback returns a false value. If such an element is found, the every method immediately returns false.

In other words, you could do something convoluted like this (link to JSFiddle):

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

This will alert 1 through 3, and then "break" out of the loop.

You're using underscore.js, so you'll be pleased to learn that it does provide an every method—they call it every, but as that link mentions, they also provide an alias called all.

Upvotes: 275

percebus

Reputation: 847

It's also good to note that an each loop cannot be broken out of — to break, use _.find instead.

http://underscorejs.org/#each

Upvotes: 2

Nikhil

Reputation: 905

Update:

_.find would be better as it breaks out of the loop when the element is found:

var searchArr = [{id:1,text:"foo"},{id:2,text:"bar"}];
var count = 0;
var filteredEl = _.find(searchArr,function(arrEl){ 
              count = count +1;
              if(arrEl.id === 1 ){
                  return arrEl;
              }
            });

console.log(filteredEl);
//since we are searching the first element in the array, the count will be one
console.log(count);
//output: filteredEl : {id:1,text:"foo"} , count: 1

** Old **

If you want to conditionally break out of a loop, use _.filter api instead of _.each. Here is a code snippet

var searchArr = [{id:1,text:"foo"},{id:2,text:"bar"}];
var filteredEl = _.filter(searchArr,function(arrEl){ 
                  if(arrEl.id === 1 ){
                      return arrEl;
                  }
                });
console.log(filteredEl);
//output: {id:1,text:"foo"}

Upvotes: 71

Rockyboy_ruby

Reputation: 233

_([1,2,3]).find(function(v){
    return v if (v==2);
})

Upvotes: 6

bm_i

Reputation: 598

Update:

You can actually "break" by throwing an error inside and catching it outside: something like this:

try{
  _([1,2,3]).each(function(v){
    if (v==2) throw new Error('break');
  });
}catch(e){
  if(e.message === 'break'){
    //break successful
  }
}

This obviously has some implications regarding any other exceptions that your code trigger in the loop, so use with caution!

Upvotes: 1

JaredMcAteer

Reputation: 22536

You cannot break a forEach in underscore, as it emulates EcmaScript 5 native behaviour.

Upvotes: 3

bm_i

Reputation: 598

I believe if your array was actually an object you could return using an empty object.

_.({1,2,3,4,5}).each(function(v){  
  if(v===3) return {}; 
});

Upvotes: 2

czizzy

Reputation: 87

Like the other answers, it's impossible. Here is the comment about breaker in underscore underscore issue #21

Upvotes: 3

grantwparks

Reputation: 1153

Maybe you want Underscore's any() or find(), which will stop processing when a condition is met.

Upvotes: 3

how to break the _.each function in underscore.js

Answers (11)

Related Questions