co README

The project's README from github.com/tj/co. As one markdown file: README.md.

co

Gitter NPM version Build status Test coverage Downloads

Generator based control flow goodness for nodejs and the browser, using promises, letting you write non-blocking code in a nice-ish way.

Co v4

[email protected] has been released, which now relies on promises. It is a stepping stone towards the async/await proposal. The primary API change is how co() is invoked. Before, co returned a "thunk", which you then called with a callback and optional arguments. Now, co() returns a promise.

co(function* () {
  var result = yield Promise.resolve(true);
  return result;
}).then(function (value) {
  console.log(value);
}, function (err) {
  console.error(err.stack);
});

If you want to convert a co-generator-function into a regular function that returns a promise, you now use co.wrap(fn*).

var fn = co.wrap(function* (val) {
  return yield Promise.resolve(val);
});

fn(true).then(function (val) {

});

Platform Compatibility

co@4+ requires a Promise implementation. For versions of node < 0.11 and for many older browsers, you should/must include your own Promise polyfill.

When using node 0.10.x and lower or browsers without generator support, you must use gnode and/or regenerator.

When using node 0.11.x, you must use the --harmony-generators flag or just --harmony to get access to generators.

Node v4+ is supported out of the box, you can use co without flags or polyfills.

Installation

$ npm install co

Associated libraries

Any library that returns promises work well with co.

View the wiki for more libraries.

Examples

var co = require('co');

co(function *(){
  // yield any promise
  var result = yield Promise.resolve(true);
}).catch(onerror);

co(function *(){
  // resolve multiple promises in parallel
  var a = Promise.resolve(1);
  var b = Promise.resolve(2);
  var c = Promise.resolve(3);
  var res = yield [a, b, c];
  console.log(res);
  // => [1, 2, 3]
}).catch(onerror);

// errors can be try/catched
co(function *(){
  try {
    yield Promise.reject(new Error('boom'));
  } catch (err) {
    console.error(err.message); // "boom"
 }
}).catch(onerror);

function onerror(err) {
  // log any uncaught errors
  // co will not throw any errors you do not handle!!!
  // HANDLE ALL YOUR ERRORS!!!
  console.error(err.stack);
}

Yieldables

The yieldable objects currently supported are:

Nested yieldable objects are supported, meaning you can nest promises within objects within arrays, and so on!

Promises

Read more on promises!

Thunks

Thunks are functions that only have a single argument, a callback. Thunk support only remains for backwards compatibility and may be removed in future versions of co.

Arrays

yielding an array will resolve all the yieldables in parallel.

co(function* () {
  var res = yield [
    Promise.resolve(1),
    Promise.resolve(2),
    Promise.resolve(3),
  ];
  console.log(res); // => [1, 2, 3]
}).catch(onerror);

Objects

Just like arrays, objects resolve all yieldables in parallel.

co(function* () {
  var res = yield {
    1: Promise.resolve(1),
    2: Promise.resolve(2),
  };
  console.log(res); // => { 1: 1, 2: 2 }
}).catch(onerror);

Generators and Generator Functions

Any generator or generator function you can pass into co can be yielded as well. This should generally be avoided as we should be moving towards spec-compliant Promises instead.

API

co(fn*).then( val => )

Returns a promise that resolves a generator, generator function, or any function that returns a generator.

co(function* () {
  return yield Promise.resolve(true);
}).then(function (val) {
  console.log(val);
}, function (err) {
  console.error(err.stack);
});

var fn = co.wrap(fn*)

Convert a generator into a regular function that returns a Promise.

var fn = co.wrap(function* (val) {
  return yield Promise.resolve(val);
});

fn(true).then(function (val) {

});

License

MIT

co (tj/co)

Searching Database…

11.8K ·GitHub
Co
Что это такое?co — это небольшая JavaScript-библиотека для Node.js, которая даёт управление потоком выполнения на основе генераторов: вы пишете асинхронный неблокирующий код, который читается как обычный последовательный, а под капотом работают промисы.
Это библиотека, которую я подключаю к своему коду, или отдельный инструмент?Библиотека: вы устанавливаете её из npm и подключаете через require в своём JavaScript-коде. У неё нет ни одной зависимости, а из того же исходного кода собирается отдельный браузерный бандл (co-browser.js).
Как добавить её в проект на Node и начать пользоваться?Установите через npm install co, подключите её, затем напишите асинхронные шаги внутри функции-генератора (function*) и передайте её в co(), например co(function* () { ... }).
Нужна ли какая-то конкретная версия Node или полифилл, чтобы всё работало?co@4+ требует наличия реализации Promise, поэтому на старых версиях Node понадобится полифилл; пакет рассчитан на Node >= 0.12 и io.js >= 1.0.
В чём подвох — что может меня подловить?Ваш асинхронный код должен находиться внутри функций-генераторов, а версия v4 стала ломающим изменением: раньше co возвращала thunk, который вызывался с колбэком, а co@4 вместо этого возвращает промис.
Она работает и в браузере, или только в Node?И там, и там: библиотека сделана для Node.js и браузера, а в репозитории есть отдельный браузерный бандл (co-browser.js), собранный с помощью browserify.
Что можно передать в co() и что я получу обратно?Генератор, функцию-генератор или любую функцию, которая возвращает генератор, — co запустит её и вернёт вам один промис на весь процесс.
Когда мне использовать co.wrap() вместо прямого вызова co()?co.wrap(fn) превращает функцию-генератор в обычную функцию, которая возвращает промис, — её можно сохранить и вызвать позже с аргументами, как любую обычную функцию.
Она тянет за собой какие-то зависимости?Нет — у пакета ноль зависимостей во время выполнения; промисы и генераторы даёт сама платформа JavaScript.
Есть ли смысл в co сейчас, когда в JavaScript есть нативный async/await?В README co@4 названа ступенькой на пути к предложению async/await — то есть её API предвосхитило то, что язык позже принял нативно. Новый код сегодня решает те же задачи через async/await; co в основном нужна для старых кодовых баз на Node.
What are similar projects?validator.js, q, core-js, JSVerbalExpressions, async, classnames, comlink, mongoose
Which topics is it in?generator, es6, concurrency, async, javascript-library, browser, backend, npm, nodejs, library, javascript, web
Creator
tj
Size
0.4 MB
Stars
11.8K
Updated
CommitOct 17
Age
13y
Commits · 90 Days