minibase-control-flow v1.0.0

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

• Install
• Usage
• API
  • minibaseControlFlow
  • .serial
  • .parallel
  • .each
  • Options
  • Hooks
  • Item
  • Finish hook
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(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. The opts 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-promise
• returns {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 optional opts (see options section) and optional mapper 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 in iterable, see item section
• [opts] {Object}: see options section
• returns {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 with opts.concurrency) with optional opts (see options section) and optional mapper 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 in iterable, see item section
• [opts] {Object}: see options section
• returns {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 default opts. Pass opts.serial: true if you want to iterate in series, pass opts.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 in iterable, see item section
• [opts] {Object}: see options section
• returns {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 native
• mapper {Function}: function to apply to each item in iterable, see item section
• settle {Boolean}: if false stops after first error (also known as "fail-fast" or "bail"), default true
• flat {Boolean}: result array to contain only values, default true
• concurrency {Number}: works only with .parallel method, defaults to iterable length
• start {Function}: on start hook, see hooks section
• beforeEach {Function}: called before each item in iterable, see hooks section
• afterEach {Function}: called after each item in iterable, see hooks section
• finish {Function}: called at the end of iteration, see hooks section

back to top

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 anything
• beforeEach {Function}: passed with item, index, arr arguments
  • item is an object with value, reason and index properties, see item section
  • index is the same as item.index
  • arr is the iterable object - array or object
• afterEach {Function}: passed with item, index, arr arguments
  • item is an object with value, reason and index properties, see item section
  • index is the same as item.index
  • arr is the iterable object - array or object
• finish {Function}: called at the end of iteration, see finish hook section

back to top

Item

That object is special object, that is passed to beforeEach and afterEach hooks, also can be found in result object if you pass opts.flat: false option. And passed to opts.mapper function too.

• item.value resolved/rejected promise value, if at beforeEach hook it can be function
• item.reason may not exist if item.value, if exist it is standard Error object
• item.index is number, order of "executing", not the order that is defined in iterable

back to top

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, if opts.settle: false, otherwise null
• result is always an array with values or item objects if opts.flat: false

back to top

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

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. 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

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

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.