co-array

co-array

... is deprecated!

Deprecation

As I learned more about co, thunks, promises, and generators, I figured that this module only adds little to things that can be done in a more "native" approach.

Basically, using only the native functions of the array can achieve the same principle. With a combination of .map and .filter, most of the functionalities become obsolete. Chain with other native array functions to complete the missing features.

(yield ['foo', true, 'bar'].map(function (item) {
  return function * () {
    return item === true ? undefined : item + '!';
  };
})).filter(function (item) {
  return item !== undefined;
}).sort(function (a, b) {
  return a.localeCompare(b);
}).reduce(function (accu, item, index) {
  return accu  + '::' + index + '::' + item;
}));    // "bar!::1::foo!"

Installation

npm install co-array --save

Usage

var coArray = require('co-array');

co(function * () {
  var items = yield fetchAllItems();

  return yield coArray(items)
    .filter(itemFilter)
    .sort(itemSorter)
    .result;
})(function (err, items) {

  console.log("Resulting items:", items);

});

function * itemFilter(item) { ... }
function * itemSorter(a, b) { ... }

NOTE : The basic usage is yield coArray(arr).result; which will return arr.

Available functions

Each of the following functions require two argument; an Array and a Function (or GeneratorFunction, etc.).

• every
• filter
• find
• findIndex
• forEach
• map
• reduce
• reduceRight
• some
• sort

Each function is processed in their calling order.

Each function may be loaded individually. For example :

var forEach = require('co-array/lib/for-each');

yield forEach(arr, function * (item) { ... });

Contribution

All contributions welcome! Every PR must be accompanied by their associated unit tests!

License

The MIT License (MIT)

Copyright (c) 2014 Mind2Soft [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.