tanem / gco

:loop: Generator based flow-control that supports promises.

gco

Generator based flow-control that supports promises.

Motivation

Developed for a specific use-case, and for learning purposes. Heavily inspired by co, which I recommend using if you're after a more feature-rich and battle-tested solution 😃. You'll see co's influence in the documentation, API, and unit tests.

Compatibility

Babel is used to transpile ES2015 to ES5. gco is tested against:

• The latest stable Node.js release
• The latest LTS Node.js release
• The browsers listed in the build matrix above.

Installation

$ npm i gco

Usage

import gco from 'gco';

const onError = ({ stack }) => console.error(stack);

// Yield any promise.
gco(function* () {
  const result = yield Promise.resolve(true);
  console.log(result);
  // -> true
}).catch(onError);

// Yield an array to resolve multiple promises in parallel.
gco(function* () {
  const a = Promise.resolve(1);
  const b = Promise.resolve(2);
  const c = Promise.resolve(3);
  const result = yield [a, b, c];
  console.log(result);
  // -> [1, 2, 3]
}).catch(onError);

// Yield an object to resolve multiple promises in parallel.
gco(function* () {
  const res = yield {
    1: Promise.resolve(1),
    2: Promise.resolve(2),
  };
  console.log(res);
  // -> { 1: 1, 2: 2 }
}).catch(onError);

// Errors can be try/catched.
gco(function* () {
  try {
    yield Promise.reject(new Error('boom'));
  } catch (error) {
    console.error(error.message);
    // -> 'boom'
  }
}).catch(onError);

To run the above examples:

$ npm run example -s

API

gco(fn*).then(value =>)

Returns a promise that resolves a generator.

Tests

$ npm run test:local

License

MIT

gco's Issues

Use babel-node for tests

Fix export in index.es6

test against the built file

Add ability to yield objects

Ref: co#objects

gco(function* () {
  const res = yield {
    1: Promise.resolve(1),
    2: Promise.resolve(2),
  };
  console.log(res);
  // -> { 1: 1, 2: 2 }
}).catch(onError);

Add directories metadata to package.json

"directories": {
  "example": "example",
  "lib": "src",
  "test": "test"
}

Don't enforce promise and generator implementations

Use prepublish for src

Test against the built file

Don't enforce promise and generator implementations?

Update compatibility

Babel is being used to transpile the code, so:

• No need for notes about promise and generator polyfills in README.md
• engines should be updated in package.json too.

Only run browser tests once

move issues to ROADMAP.md

Set up eslint

Babelify the bin dir?