evented-async-loop

0.1.1 • Public • Published

evented-async-loop Build Status

Loop through asynchronous code with events

Installation

npm install evented-async-loop

Usage

Check examples and test folders for more details.

Basic

'use strict';
 
var asyncLoop = require('../index');
var dummyArray = require('./dummyArray');
 
 
//Make an array of asynchronous functions
var arr = dummyArray(10);
 
var loop = asyncLoop.create(arr);
 
loop.on('next', function (elm, i, array) {
    elm(function() {
        console.log(i);
        loop.next();
    });
});
 
loop.on('done', function () {
    console.log('Done!');
});
 
loop.start();

Chaining

//All methods accept .next are chainable
loop.on('next', function (elm, i, array) {
    elm(function () {
        console.log(i);
        loop.next();
    });
}).on('done', function () {
    console.log('Done!');
}).start();

Exit early

loop.on('next', function (elm, i, array) {
    elm(function () {
        if (=== 5) {
            // Stop the loop early, you can pass any number of arguments to .done
            loop.done(i, 'i am Batman');
        }
        loop.next();
    });
}).on('done', function (i, msg) {
    console.log('Loop stopped at %s and %s', i, msg);
}).start();

Data propagation

// loop.start(...).on() is ok too!
loop.on('next', function (elm, i, array, arg1, arg2) { // extra arguments are appended
    elm(function () {
        // pass data to the next iteration
        loop.next(++arg1, arg2);
        // after the final iteration tha arguments are passed to 'done'
    });
}).on('done', function (arg1, arg2) {
    console.log('arg1: %s, arg2: %s', arg1, arg2);
}).start(0, 'blah'); // Pass any number of arguments

Error handling

loop.on('next', function (elm, i, array) {
    elm(function () {
        if (=== 3) {
            // Emitting an error event will not break the loop
            loop.error('Oh noez!');
        }
 
        if (=== 8) {
            // But if you need to break the loop and emit an error
            loop.break().error('This will stop the loop');
            // or, loop.error('This will stop the loop').break();
            // if you want to emit the error first
        }
 
        loop.next();
    });
}).on('done', function () {
    // This wont run
    console.log('Done!');
}).on('error', function (err) {
    console.log(err);
}).start();

API

Events

  • next[element, i, array, arg1, ...]
  • done[arg1, ...]
  • error[arg1, ...]

Methods

  • .start([arg1, ...]): Start the loop.Passes arguments to the first next event
  • .next([arg1, ...]): Go to the next iteration. Passes agruments to next event. If the loop is completed done is emitted instead.
  • .done([arg1, ...]): Stop the loop early. Passes arguments to done event
  • .error([err]): Emit an error event
  • .break(): Break the loop. it wont emit done

Test

Change your working directory to the project's root, npm install to get the development dependencies and then npm test

Package Sidebar

Install

npm i evented-async-loop

Weekly Downloads

52

Version

0.1.1

License

ISC

Last publish

Collaborators

  • j.chaniotis