genny

A tiny ES6 (harmony) library for node 0.11.2+ that helps you use generators with node style callbacks.

genny

A tiny ES6 (harmony) library for node 0.11.2 and up that helps you use generators with node style callbacks, similar to suspend

usage examples

Spawn a generator task. From within your task, call your async functions with yield and pass them a resume function instead of a callback:

genny.run(function* (resume) {
    console.log("Hello");
    yield setInterval(resume(), 1000);
    console.log("World");
});

Handle errors with try/catch, or as return results via resume.nothrow

function errors(cb) {
    setImmediate(cb.bind(this, new Error('oops')));
}
genny.run(function* (resume) {
    // Throwing resume 
    try { yield errors(resume()); } 
    catch (e) { /* handle the oops error */ }
    // Non-throwing resume 
    var err = yield errors(resume.nothrow());
    if (err) { /* handle oops error */ }
});
 

Dont like nested parens? Want to keep things brief? Use resume.t instead of resume() and resume.nt instead of resume.nothrow()

Want to catch all uncaught exceptions? You can pass a callback argument to genny.run. Infact, you can use genny instead to create a function which can accept multiple arguments and a callback. The arguments will be passed to your generator right after resume.

var myfunc = genny(function* (resumearg1) {
    assert.equal(arg1, 'arg1', 'argument passed')
    var err = yield errors(resume.t);
});
 
myfunc('arg1', function(err) {
    // thrown error propagates here automagically  
});

note: make sure that you pass the callback last.

Your async functions call the callback with more than 2 arguments? Not a problem - the yield call from within your task will return an array instead.

function returnsmore(callback) {
    callback(null, 'arg1', 'arg2');
}
 
genny.run(function* (resume) {
    var res = yield returnsmore(resume.t);
    var arg1 = res[0];
    var arg2 = res[1];
    var nothrowres = yield returnsmore(resume.nt);
    var err = res[0];
    var arg1 = res[1];
    var arg2 = res[2];
});

Look in test/index.js for more examples and tests.

thanks

jmar777 for his awesome suspend library which served as the base for genny

licence

MIT