npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

create-coroutine

v1.0.2

Published

Create a coroutine

Downloads

7

Readme

create-coroutine

Install

npm install create-coroutine

Usage

Regular

var cc = require('create-coroutine'),
    fs = require('fs');

function readFile(){
    return new Promise(function(resolve, reject){
        fs.readFile(name, 'utf8', function(e, str){
            if(e) return reject(e);
            resolve(str);
        });
    });
}

var routine = cc(function * function(){
    var text1 = yield readFile('stuff.txt'),
        text2 = yield readFile('script.js');

    return [text1, text2];
});

routine().then(function(value){
    //value is the return value from the generator.
});

Or run your function right away:

cc.run(function * function(){
    var text1 = yield readFile('stuff.txt'),
        text2 = yield readFile('script.js');

    return [text1, text2];
}).then(function(value){
    //value is the return value from the generator.
});

Streams

var cc = require('create-coroutine'),
    fs = require('fs');

function readFile(){
    return new Promise(function(resolve, reject){
        fs.readFile(name, 'utf8', function(e, str){
            if(e) return reject(e);
            resolve(str);
        });
    });
}

var routine = cc(function * function(){
    //Ready to do streaming.
    yield [
        fs.createReadStream('sourcefile'),
        fs.createWriteStream('destination')
    ];

    //Read the fresh contents of destination.
    var text = yield readFile('destination');

    //This will return after everything else is done.
    return text;
});

routine().then(function(value){
    //value = returned text
});

About

create-coroutine takes a single generator function as an argument. It processes your yielded values so asynchronous operations can be mixed with synchronous ones.

Yieldables

  • Primitives (String, Number, Boolean, Undefined, Null)
  • Promises (The main type of yieldable)
  • Arrays of Promises (Resolves them in parallel)
  • Objects of Promises (Resolves them in parallel)
  • Functions that accept one callback argument
  • Arrays of streams (Pipes them in order)
  • Other generators
  • Anything with a then method.

A Note About Streams

If you use the array of streams functionality keep in mind that only streams can be in that array. You can mix values only when they aren't streams. Mixing streams, and other values might create undefined behavior. You can put as many streams in the array as you want, but they must be in the correct order. For example:

//Pseudo code.
yield [
        Readable,
        Duplex/Through/Transform,
        Duplex/Through/Transform,
        ...,
        Writable/Duplex/Through/Transform
    ];

Modules That Work Well