gaffa-flow/README.md

An action for triggering other actions after a flow of model events occurs

# gaffa-flow

flow action for gaffa

## Install:

    npm i gaffa-flow

## Add to gaffa:

    gaffa.registerConstructor(require('gaffa-flow'));

# API

## Properties (instanceof Gaffa.Property)

### cancel

Binding that, when changed to a truthy value, cancels the flow.

## Properties !(instanceof Gaffa.Property)

### steps

A standard array of bindings that when evaluate to true will trigger the next step to be evaluated.

Once all steps have evaluated to true the success action will be triggered


## Example

    var flow = new Flow();

    flow.steps = [
        '[/foo]',
        '[/bar]'
    ];

    flow.actions.success[someAction];

    // Step 1
    gaffa.model.set('[/foo]', true);

    setTimeout(function(){
        // Step 2
        gaffa.model.set('[/bar]', true);
    }, 1000);

    // After step 2 is set someAction will trigger