how to break async.js each loop?

Question

Hi i am using async module of node.js for implementing a for loop asynchronously.

My question is: how to break the loop execution and get out of the loop? I tried giving return , return false but no luck.

Here is the sample code:

async.until( 

    function() { return goal; },

    function(callback) {

        async.each(_rules, 

            function(rule,callback) {

                var outcome = true;
                .... some code ....
                if(changes){ 
                      console.log("hi");
                      return false;// HERE I NEED TO BREAK
                } 
                else
                callback();

            }, 

            function(err){  }
        );

        if (!changes || session.process)                
            goal = true;

        callback();
    },

    function(err){ callback(session); }     
);

you can break by sending something in the first parameter of the callback (which async will interpret as an "error" and stop the loop). Make it a known value (a truthy one) that you can check for in your final callback to know it was a break and not an error. — Chad
– Chad, Commented Feb 18, 2013 at 14:54
could you tell me how to do this here? i cant call callback(1) at the place of return false; line i have shown in the code and break it — Mithun Satheesh
– Mithun Satheesh, Commented Feb 18, 2013 at 15:11
If you don't call the callback in all paths, then the loop will never "end". If you have a path not calling the callback, then you are doing it wrong. This is asynchronous, your return value does nothing. — Chad
– Chad, Commented Feb 18, 2013 at 15:21

user568109 · Accepted Answer · 2014-01-12 16:33:22Z

7

async.until repeatedly calls function until the test returns true. So test must return true so that you exit the loop. This is opposite of async.whilst which runs repeatedly while test evaluates to be true.

async.each calls the functions in parallel so what it returns does not matter. It is not a loop which you can break, but an iterator looping over the array. Your condition to stop using async.each should be in test for async.until and you should iterate over the rules yourself.

edited Jan 12, 2014 at 16:33

user1046334

answered Feb 18, 2013 at 14:57

user568109

48.1k18 gold badges101 silver badges124 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

AndyD · Accepted Answer · 2013-02-19 10:37:31Z

5

There isn't really a "loop" as such to break out of. All your items in your collection are used in parallel

The only way to "break" the "loop" is to call the callback with an error argument. As there is nothing to stop you from putting other things in there you could hack it a little bit.

From the docs:

Note, that since this function applies the iterator to each item in parallel there is no guarantee that the iterator functions will complete in order.

Even if you return an error, you will still have several outstanding requests potentially so you really want to limit the amount of items you use in one go. To limit the amount of outstanding requests, you could use eachSeries or eachLimit.

For example:

    async.each(_rules, 
        function(rule,callback) {
            if(changes){                       
                  return callback({ data: 'hi'}); // stop
            } 
            ...
            if(realerror){
               return callback({ error: realerror}); // stop with an error
            }
            callback(); // continue
        }, 

        function(result){
          if(!result){
            return othercallback('no results');
          }
          // check if we have a real error:
          if(result.error){
            return othercallback(result.error);
          }
          return othercallback(null, result.data);
        }
    );

PS: if you're not doing async, use underscore

edited Feb 19, 2013 at 10:37

answered Feb 18, 2013 at 15:06

AndyD

5,36637 silver badges33 bronze badges

4 Comments

Mithun Satheesh Over a year ago

could you tell me how to do this here? i cant call callback(1) at the place of return false; line i have shown in the code and break it

Chad Over a year ago

@mithunsatheesh Short answer: you have to, and yes you can.

AndyD Over a year ago

instead of return false, just do "return callback({data:false})" and check the first argument in the final callback.

Jujhar Singh Over a year ago

Didn't fix my issue as such, but inspired me to try a different approach.

João Pimentel Ferreira · Accepted Answer · 2022-11-16 19:42:01Z

0

You have also async.detect

Returns the first value in coll that passes an async truth test. The iteratee is applied in parallel, meaning the first iteratee to return true will fire the detect callback with that result.

// asynchronous function that checks if a file exists
function fileExists(file, callback) {
   fs.access(file, fs.constants.F_OK, (err) => {
       callback(null, !err);
   });
}

async.detect(['file3.txt','file2.txt','dir1/file1.txt'], fileExists,
   function(err, result) {
       console.log(result);
       // dir1/file1.txt
       // result now equals the first file in the list that exists
   }
);

answered Nov 16, 2022 at 19:42

João Pimentel Ferreira

16.5k13 gold badges98 silver badges131 bronze badges

Collectives™ on Stack Overflow

how to break async.js each loop?

3 Answers 3

Comments

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related