reflux-promise

Plugin for reflux-core to use Promises.

Here are the API docs for reflux-promise.

Installation

You can currently install the package as an npm package.

NPM

The following command installs reflux-promise as an npm package:

npm install reflux-promise

Usage

To install promise functionality do the following in your application's bootstrapper:

1import Reflux from "reflux";
2import RefluxPromise from "reflux-promise";
3
4// Uses the user agent's Promise implementation
5Reflux.use(RefluxPromise(window.Promise));
6
7// Uses Q
8import Q from "q";
9Reflux.use(RefluxPromise(Q.Promise));
10
11// Uses bluebird
12import bluebird from "bluebird";
13Reflux.use(RefluxPromise(bluebird))

Extensions to Asynchronous actions

reflux-promise extends asynchronous actions, i.e.:

1// this creates 'load', 'load.completed' and 'load.failed'
2var { load } = Reflux.createActions({
3    "load": {children: ["completed","failed"]}
4});

A couple of helper methods are available to trigger the completed and failed child actions:

• promise

• listenAndPromise

The following are all equivalent:

1// Using load above with a promise here called "apiPromise"
2load.listen( function(arguments) {
3    apiPromise(arguments)
4        .then(load.completed)
5        .catch(load.failed);
6});
7
8// Can be shortened down to use `promise` like below
9load.listen( function(arguments) {
10    load.promise( apiPromise(arguments) );
11});
12
13// Furthermore with `listenAndPromise`
14load.listenAndPromise( apiPromise );

Asynchronous actions as Promises

PublisherMethods#triggerAsync is modified so that asynchronous actions can be used as promises. The following example is for server-side rendering when you must await the successful (or failed) completion of an action before rendering. Suppose you had an action, makeGetRequest, and a store, RequestStore, to make an API request:

1// Create async action with `completed` & `failed` children
2var makeGetRequest = Reflux.createAction({ asyncResult: true });
3
4var RequestStore = Reflux.createStore({
5    init: function() {
6        this.listenTo(makeRequest, 'onMakeRequest');
7    },
8
9    onMakeGetRequest: function(url) {
10        // Assume `request` is some HTTP library (e.g. superagent)
11        request.get(url, function(err, res) {
12            if (err) {
13                return makeGetRequest.failed(err);
14            }
15            makeGetRequest.completed(body);
16        })
17    }
18});

You could use promises to make the request and either render or serve an error:

1makeGetRequest.triggerAsync('/api/something').then(function(body) {
2    // Render the response body
3}).catch(function(err) {
4    // Handle the API error object
5});

Colophon

List of contributors is available on Github.

This project is licensed under BSD 3-Clause License. Copyright (c) 2014, Mikael Brassman.

For more information about the license for this particular project read the LICENSE.md file.