Supersonic

Supersonic

A small and supersonic flow-controll library for Node.js

Install

npm install Supersonic

Usage

There are two modes, async and sync (or queued).

Async, all functions simultaneously.

var FlowAsync = require('Supersonic').Async;
 
new FlowAsync().push(function(ready){
    setTimeout(function(){
        ready();
    }, 1000);
})).push(function(ready){
    setTimeout(function(){
        ready();
    }, 2000);
}).invoke(function(){
    console.log('all ready, after 2 seconds');
});

All functions after each other. Additionally the Queue can pass data through the next([arg1, arg2, …]) calls.

var FlowQueue = require('Supersonic').Queue;
 
new FlowQueue().push(function(next){
    setTimeout(function(){
        next(3.14, 2.7218);
    }, 1000);
})).push(function(next, finish, pi, e){
    setTimeout(function(){
        finish(new Error);
    }, 2000);
}).push(function(){
    // not called because of the finish() in the previous call.
}).invoke(function(err){
    console.log('all ready, after 3 seconds');
});

That's it!

Passing more data

With FlowQueue it is possible to pass arguments. However when a lot of arguments have to be passed, this can be a bit tedious. Fortunately this can be easily avoided by putting the data on an object.

var data = {};
new FlowAsync().push(function(ready){
    setupDatabase(function(db){
        data.db = db;
        ready();
    });
}).push(function(ready){
    setupCache(function(cache){
        data.cache = cache;
        ready();
    });
}).invoke(function(){
    console.log(data);
});

MIT License

Copyright (c) 2014 Arian Stolwijk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.