breeze

Breeze

Functional async flow control library.

Install

• Download the latest package
• NPM: npm install breeze

Usage

Node.js / Browserify

var breeze = require('breeze')

API

• breeze(next) - Initialize breeze flow system, supports initial .then method.
• .when(arg, next) - When arg is truthy, add next to the stack
• .maybe(arg, next) - When arg is truthy, add next to the stack, sugar for breeze.when
• .some(arg, next) - When arg is truthy and no other some or none has ran, add to the stack
• .none(next) - Whenever no some have ran, add callback to the stack
• .then(next) - Add callback to stack
• .catch(next) - Any error caught will terminate stack and be sent here
• .reset() - Reset current system

Example

// initialize our step system
// the method passed here is passed to .then, its optional, you can omit it.
breeze(function (done) {
  done()
})
// truthy check
.maybe(1 === 1, function (done) {
  console.log(1)
  done(null, 'hey,', 'you can pass values!')
})
// checks can also be functions and are passed previous values.
.some(function (part1, part2) {
  return 1 === 0
}, function (done, msg) {
  console.log(2, msg)
  done()
})
// invoked only when no .some checks pass.
.none(function (done, part1, part2) {
  console.log(2, ',since no some happened,', part1, part2)
  done()
})
// always invoked as long as the chain continues.
.then(function (done) {
  console.log(3)
  done('It finally happened.')
})
// invoked on error
.catch(function (err) {
  console.error('An error occurred!', err)
})

License

Licensed under The MIT License.