dataflow-js

dataflow-js
========

DataFlow JS provides an actor-based programming model that supports in-process message passing for coarse-grained dataflow and pipelining tasks.


Installation

Using npm package manager for nodejs module:

``
npm install --save dataflow-js
`

API

$3

ActionBlock class provides a dataflow block that invokes a provided action for every data element posted.

`js
var ActionBlock = require('dataflow-js').ActionBlock;

var addToBasket = new ActionBlock(function(product, price, quantity) {
console.log('Adding product', product);
// ...
});

addToBasket.post('Shoes', 49, 2);
addToBasket.post('Pants', 19, 3);

`

#### Methods

- post() Posts a data element to this dataflow block.

#### Properties

- completion q promise for all running actions started by post() calls.

$3

BatchBlock class provides a dataflow block that batches inputs into arrays.

`js
var BatchBlock = require('dataflow-js').BatchBlock;
var ActionBlock = require('dataflow-js').ActionBlock;

var batchedAddToBasket = new BatchBlock(3);

var addToBasket = new ActionBlock(function(products) {
// products == [ ['Shoes', 49, 2], ['Pants', 19, 3], ['Trousers', 29, 1] ]
});

batchedAddToBasket.linkTo(addToBasket);

batchedAddToBasket.post('Shoes', 49, 2);
batchedAddToBasket.post('Pants', 19, 3);
// No relay to addToBasket post() yet
batchedAddToBasket.post('Trousers', 29, 1);
// Batch size reached, the 3 post() commands are relayed to addToBasket

`

#### Methods

- post() Posts a data element to this dataflow block.
- trigger() Transfer pending post() call to next blocks even if batch size is not reached.

#### Properties

- completion q promise for all running actions started by post()` calls.