minibase-control-flow
v1.0.0
Published
Plugin for [minibase][] and [base][] that adds control flow methods `.serial` and `.parallel` to your application, based on the power of [each-promise][] lib for dealing with async flow.
Downloads
14
Readme
minibase-control-flow
Plugin for minibase and base that adds control flow methods
.serial
and.parallel
to your application, based on the power of each-promise lib for dealing with async flow.
You might also be interested in each-promise.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
Install with npm
$ npm install minibase-control-flow --save
or install using yarn
$ yarn add minibase-control-flow
Usage
For more use-cases see the tests
const minibaseControlFlow = require('minibase-control-flow')
API
minibaseControlFlow
Adds
.serial
and.parallel
methods to your application. Theopts
object is merged with app's options and it is passed to respective each-promise methods. See options section.
Params
opts
{Object}: optional, passed directly to each-promisereturns
{Function}: plugin that can be passed to base/minibase's.use
method
Example
var flow = require('minibase-control-flow')
var MiniBase = require('minibase').MiniBase
var app = new MiniBase()
app.use(flow())
// or as Base plugin
var Base = require('base')
var base = new Base()
base.use(flow())
.serial
Iterate over
iterable
in series (serially) with optionalopts
(see options section) and optionalmapper
function (see item section).
Params
<iterable>
{Array|Object}: iterable object like array or object with any type of values[mapper]
{Function}: function to apply to each item initerable
, see item section[opts]
{Object}: see options sectionreturns
{Promise}
Example
var delay = require('delay')
var flow = require('minibase-control-flow')
var app = require('minibase')
app.use(flow())
var arr = [
() => delay(500).then(() => 1),
() => delay(200).then(() => { throw Error('foo') }),
() => delay(10).then(() => 3),
() => delay(350).then(() => 4),
() => delay(150).then(() => 5)
]
app.serial(arr)
.then((res) => {
console.log(res) // [1, Error: foo, 3, 4, 5]
})
// see what happens when parallel
app.parallel(arr)
.then((res) => {
console.log(res) // => [3, 5, Error: foo, 4, 1]
})
// pass `settle: false` if you want
// to stop after first error
app.serial(arr, { settle: false })
.catch((err) => console.log(err)) // => Error: foo
.parallel
Iterate concurrently over
iterable
in parallel (support limiting withopts.concurrency
) with optionalopts
(see options section) and optionalmapper
function (see item section).
Params
<iterable>
{Array|Object}: iterable object like array or object with any type of values[mapper]
{Function}: function to apply to each item initerable
, see item section[opts]
{Object}: see options sectionreturns
{Promise}
Example
var flow = require('minibase-control-flow')
var app = require('minibase')
app.use(flow())
var arr = [
function one () {
return delay(200).then(() => {
return 123
})
},
Promise.resolve('foobar'),
function two () {
return delay(1500).then(() => {
return 345
})
},
delay(10).then(() => 'zero'),
function three () {
return delay(400).then(() => {
coffffnsole.log(3) // eslint-disable-line no-undef
return 567
})
},
'abc',
function four () {
return delay(250).then(() => {
return 789
})
},
function five () {
return delay(100).then(() => {
sasasa // eslint-disable-line no-undef
return 444
})
},
function six () {
return delay(80).then(() => {
return 'last'
})
}
]
// does not stop after first error
// pass `settle: false` if you want
app.parallel(arr).then((res) => {
console.log(res)
// => [
// 'foobar',
// 'abc',
// 'zero',
// 'last',
// ReferenceError: sasasa is not defined,
// 123,
// 789,
// ReferenceError: coffffnsole is not defined
// 345
// ]
})
.each
Iterate over
iterable
in series or parallel (default), depending on defaultopts
. Passopts.serial: true
if you want to iterate in series, passopts.serial: false
or does not pass anything for parallel.
Params
<iterable>
{Array|Object}: iterable object like array or object with any type of values[mapper]
{Function}: function to apply to each item initerable
, see item section[opts]
{Object}: see options sectionreturns
{Promise}
Example
var delay = require('delay')
var app = require('minibase')
var flow = require('minibase-control-flow')
app.use(flow())
var promise = app.each([
123,
function () {
return delay(500).then(() => 456)
},
Promise.resolve(678),
function () {
return 999
},
function () {
return delay(200).then(() => 'foo')
}
])
promise.then(function (res) {
console.log('done', res) // => [123, 678, 999, 'foo', 456]
})
Options
You have control over everything, through options.
Promise
{Function}: custom Promise constructor to be used, defaults to nativemapper
{Function}: function to apply to each item initerable
, see item sectionsettle
{Boolean}: iffalse
stops after first error (also known as "fail-fast" or "bail"), defaulttrue
flat
{Boolean}: result array to contain only values, defaulttrue
concurrency
{Number}: works only with.parallel
method, defaults toiterable
lengthstart
{Function}: on start hook, see hooks sectionbeforeEach
{Function}: called before each item initerable
, see hooks sectionafterEach
{Function}: called after each item initerable
, see hooks sectionfinish
{Function}: called at the end of iteration, see hooks section
Hooks
You can do what you want between stages through hooks - start, before each, after each, finish.
start
{Function}: called at the start of iteration, before anythingbeforeEach
{Function}: passed withitem, index, arr
argumentsitem
is an object withvalue
,reason
andindex
properties, see item sectionindex
is the same asitem.index
arr
is the iterable object - array or object
afterEach
{Function}: passed withitem, index, arr
argumentsitem
is an object withvalue
,reason
andindex
properties, see item sectionindex
is the same asitem.index
arr
is the iterable object - array or object
finish
{Function}: called at the end of iteration, see finish hook section
Item
That object is special object, that is passed to
beforeEach
andafterEach
hooks, also can be found inresult
object if you passopts.flat: false
option. And passed toopts.mapper
function too.
item.value
resolved/rejected promise value, if atbeforeEach
hook it can befunction
item.reason
may not exist ifitem.value
, if exist it is standard Error objectitem.index
is number, order of "executing", not the order that is defined initerable
Finish hook
This hooks is called when everything is finished / completed. At the very end of iteration. It is passed with
err, result
arguments where:
err
is an Error object, ifopts.settle: false
, otherwisenull
result
is always an array with values or item objects ifopts.flat: false
Related
- always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
- each-promise: Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start… more | homepage
- minibase-better-define: Plugin for base and minibase that overrides the core
.define
method to be more better. | homepage - minibase-create-plugin: Utility for minibase and base that helps you create plugins | homepage
- minibase-is-registered: Plugin for minibase and base, that adds
isRegistered
method to your application to detect if plugin is already registered and… more | homepage - minibase-results: Plugin for minibase that adds useful initial properties for test results | homepage
- minibase-tests: Tests for applications built on minibase or base. All Base apps passes these tests. | homepage
- minibase-visit: Plugin for minibase and base, that adds
.visit
method to your application to visit a method over the items in… more | homepage - minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
- try-catch-callback: try/catch block with a callback, used in try-catch-core. Use it when you don't care about asyncness so much and don't… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.
In short: If you want to contribute to that project, please follow these things
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run commit
to commit changes instead ofgit commit
, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - Do NOT bump the version in package.json. For that we use
npm run release
, which is standard-version and follows Conventional Changelog idealogy.
Thanks a lot! :)
Building docs
Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb
command like that
$ npm install verbose/verb#dev verb-generate-readme --global && verb
Please don't edit the README directly. Any changes to the readme must be made in .verb.md.
Running tests
Clone repository and run the following in that cloned directory
$ npm install && npm test
Author
Charlike Mike Reagent
License
Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.
This file was generated by verb-generate-readme, v0.2.0, on December 05, 2016.