promise-flow

promise-flow

Utility module for functions that return promises

Example

import * as pf from 'promise-flow';

pf.allObject({
  key1: Promise.resolve('value from a promise'),
  key2: 'non-promise value'
}).then(function(result) {
  // result == { key1: 'value from a promise', key2: 'non-promise value' }
});

API

allObject(object)

Returns a promise that resolves with a copy of the input object when all values have resolved.

promise_flow.allObject({
  key1: Promise.resolve('value from a promise'),
  key2: 'non-promise value'
}).then(function(result) {
  // result == { key1: 'value from a promise', key2: 'non-promise value' }
});

series(factories)

Signature series<T>(factories: Array<() => Promise<T> | T): Array<T>

Takes an array of functions that will be executed in series. Each one will wait until the previous function is done.

If one of the functions returns a rejected promise or throws an error then the resulting promise will reject with that error.

promise_flow.series([
  () => Promise.resolve('value from a promise'),
  () => 'non-promise value'
]).then(function(result) {
  // result == ['value from a promise', 'non-promise value']
});

parallel(factories)

Signature parallel<T>(factories: Array<() => Promise<T> | T): Array<T>

Same as series but will run all functions in parallel.