bbq
v0.1.1
Published
AOP with Promises
Downloads
75
Readme
bbq
AOP with Promises
usage example
var bbq = require('bbq')
function foo(){
// return a promise
}
bbq(foo, {
before: function () {
this.start = Date.now()
},
after: function () {
this.end = Date.now()
this.elapsed = this.end - this.start
console.log('promise resolved in ' + this.elapsed + 'ms')
}
})
.then(function (resolvedValOfFoo) {
// stuff
})
api
bbq: (promiser: () => Promise, advice?: {before: Function, after: Function}) => Promise
before
and after
are AOP advice, functions which can modify the control flow of the promiser
.
- Advice can modify the return value by returning other than undefined or a Promise of undefined.
- Advice is called in the
this
context of astate
object, which can be used to keep track of state between before and after advice for thatpromiser
invocation. - If
before
advice returns a value, it will short-circuit thepromiser
from being called. after
advice hasthis.val
set to the return value of thepromiser
. Ifafter
returns a value other than undefined or a Promise of undefined, it will be the ultimate resolved value; otherwisethis.val
will be used.
installation
$ npm install bbq
running the tests
From package root:
$ npm install
$ npm test
contributors
- jden [email protected]
license
MIT. (c) MMXIII jden [email protected]. See LICENSE.md