rfunc-mock

rfunc-mock
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/rfunc-labo/rfunc-mock
[bd_travis_url]: http://travis-ci.org/rfunc-labo/rfunc-mock
[bd_travis_shield_url]: http://img.shields.io/travis/rfunc-labo/rfunc-mock.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/rfunc-labo/rfunc-mock
[bd_travis_com_shield_url]: https://api.travis-ci.com/rfunc-labo/rfunc-mock.svg?token=
[bd_license_url]: https://github.com/rfunc-labo/rfunc-mock/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/rfunc-labo/rfunc-mock
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/rfunc-labo/rfunc-mock.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/rfunc-labo/rfunc-mock.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/rfunc-labo/rfunc-mock
[bd_gemnasium_shield_url]: https://gemnasium.com/rfunc-labo/rfunc-mock.svg
[bd_npm_url]: http://www.npmjs.org/package/rfunc-mock
[bd_npm_shield_url]: http://img.shields.io/npm/v/rfunc-mock.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Mock utility for rfunc.

Installation
-----

``bash
$ npm install rfunc-mock --save
`

Usage
---------

`javascript
'use strict'

const co = require('co')
const { moduleProxy } = require('rfunc-mock')

co(function * () {
// Create api mock
{
let api = moduleProxy({
$before () {
/ ... /
console.log('calling the method...')
},
doSomething () {
/ ... /
return Promise.resolve('done!')
}
})
yield api.doSomething()
}
}).catch((err) => console.error(err))

`

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| .moduleProxy(module, options) -> Object` | Create a proxy for a module |

License
-------
This software is released under the MIT License.

Links
------

+ [rfunc][rfunc_url]

[rfunc_url]: https://github.com/rfunc-labo/rfunc