Giter Club home page Giter Club logo

gocsp-co's Introduction

gocsp-co

Coroutine in js world

Example

var co = require('gocsp-co')
var thunk = require('gocsp-thunk')

co(function* (x, y) {

    // yield promise
    yield new Promise((resolve, reject) => {
        resolve('hi')
    })

    // yield thunk
    yield thunk(done => {
        done()
    })

    // yield callback
    yield done => {
        done()
    }

    return x + y

// !!! caution: unlike tj's co, callback is NOT last argument
})(1, 2)(function (err, val) {
    assert(val === 3)
})

Difference with TJ's co

co() in gocsp-co will return a wrapper function which will return a thunk when called, where tj's co use last argument as callback (it's also a thunk if no other arguments).

Async Function

Use it as ES7 async function.

Example:

function asyncFunction(arg0, arg1, arg2) {
    return new Promise(co.spawn(function* () {
        // ...
        // ...
    }))
}

API Reference

co( generator_function )

Return a wrapper function which will return a thunk when called.

Example:

co(function* (x, y) {
    return x + y
})(1, 2)(function (err, val) {
    assert(val === 3)
})

co.spawn( generator_function / generator )

Return a thunk. If argument is generator function, it will be called (e.g. genFun()) and returned generator will be used for coroutine.

Example:

// with a generator
co.spawn(function* (x, y) {
    return x + y
}(1, 2))(function (err, val) {
    assert(val === 3)
})

// with a generator function
var x = 1, y = 2
co.spawn(function* () {
    return x + y
})(function (err, val) {
    assert(val === 3)
})

co.limit( num, generator_function )

Example:

co.spawn(function* () {
    // read max 10 files at the same time
    var read = co.limit(10, function* (filename) {
        return yield thunk.ify(fs.readFile)(filename)
    })
    var files = yield ['file1', 'file2', 'etc...'].map(read)
})

// gocsp-each
each(chan, co.limit(10, function* (data) {
    // ...
}))

// limit total number of connection
http.createServer(co.limit(1000, function* (req, res) {
    // ...
}))

Inspiration

Licence

MIT

gocsp-co's People

Contributors

gyson avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.