From fb5236959205029bf4462752df668db360f7bc4c Mon Sep 17 00:00:00 2001 From: Valeri Karpov Date: Thu, 1 Jan 2015 14:00:01 -0500 Subject: [PATCH] Add coveralls to README --- README.md | 35 ++++++++++++++++++++++++++++++++++- docs.js | 5 +++-- 2 files changed, 37 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c22c650..3988f7d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# kareem [![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem) +# kareem + +[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem) [![Coverage Status](https://img.shields.io/coveralls/vkarpov15/kareem.svg)](https://coveralls.io/r/vkarpov15/kareem) Re-imagined take on the [hooks](http://npmjs.org/package/hooks) module, meant to offer additional flexibility in allowing you to execute hooks whenever necessary, as opposed to simply wrapping a single function. @@ -180,6 +182,37 @@ Named for the NBA's all-time leading scorer Kareem Abdul-Jabbar, known for his m ``` +#### It can use synchronous post hooks + +```javascript + + var execed = {}; + + hooks.post('cook', function(eggs, bacon) { + execed.first = true; + assert.equal(1, eggs); + assert.equal(2, bacon); + }); + + hooks.post('cook', function(eggs, bacon, callback) { + execed.second = true; + assert.equal(1, eggs); + assert.equal(2, bacon); + callback(); + }); + + hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) { + assert.ifError(error); + assert.equal(2, Object.keys(execed).length); + assert.ok(execed.first); + assert.ok(execed.second); + assert.equal(1, eggs); + assert.equal(2, bacon); + done(); + }); + +``` + ## wrap() #### It wraps pre and post calls into one call diff --git a/docs.js b/docs.js index a4352e6..8ff1202 100644 --- a/docs.js +++ b/docs.js @@ -4,8 +4,9 @@ var content = require('fs').readFileSync('./test/examples.test.js').toString(); var blocks = acquit.parse(content); var mdOutput = - '# kareem ' + - '[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem)\n\n' + + '# kareem\n\n' + + '[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem) ' + + '[![Coverage Status](https://img.shields.io/coveralls/vkarpov15/kareem.svg)](https://coveralls.io/r/vkarpov15/kareem)\n\n' + 'Re-imagined take on the [hooks](http://npmjs.org/package/hooks) module, ' + 'meant to offer additional flexibility in allowing you to execute hooks ' + 'whenever necessary, as opposed to simply wrapping a single function.\n\n' +