autoflow-q/README.md

autoflow-q is a plugin for autoflow, the flow control rules engine, which adds integration with Q-style Deferred promises https://github.com/kriskowal/q

# autoflow-q

[![Build Status](https://secure.travis-ci.org/jeffbski/autoflow-q.png?branch=master)](http://travis-ci.org/jeffbski/autoflow-q)

react-q is a plugin for autoflow, the flow control rules engine, which adds integration with jQuery-style Deferred promises

For more information on `autoflow` the lightweight flow control rules engine:  http://github.com/jeffbski/autoflow

## Goals

 - make it easy to use autoflow defined functions, promise style and in this case with promises that are compatible with Q promises https://github.com/kriskowal/q
 - If A autoflow defined flow function is called without a callback, then a Q promise is returned
 - if promises are passed in as input parameters, they will automatically be resolved before tasks are called

## Installing

    npm install autoflow-q

OR

Pull from github - http://github.com/jeffbski/autoflow-q


## Example

```javascript
var autoflow = require('react-q'); // enable Q-style promise integration, return react
// react.logEvents(); // to enable logging to stderr of flow and task events

function loadData(x, y, cb) {
  setTimeout(function () {
    cb(null, x * y);
  }, 10);
}

function loadUser(uid, cb) {
  setTimeout(function () {
    cb(null, uid + '_user');
  }, 10);
}

function render(user, data) {
  return user + data;
}


var fn = autoflow('myflow', 'a, b, uid, cb -> err, renderedOut',
  loadData, 'a, b, cb -> err, c',
  loadUser, 'uid, cb -> err, user',
  render, 'user, c -> renderedOut'
);


var promise = fn(2, 3, 'joe');  // calling without passing in cb
promise.then(function (renderedOut) {
  console.error('renderedOut:', renderedOut);
});
```


## License

 - [MIT license](http://github.com/jeffbski/autoflow-q/raw/master/LICENSE)

## Contributors

 - Author: Jeff Barczewski (@jeffbski)

## Contributing

 - Source code repository: http://github.com/jeffbski/autoflow-q
 - Ideas and pull requests are encouraged  - http://github.com/jeffbski/autoflow-q/issues

- You may contact me at @jeffbski or through github at http://github.com/jeffbski