JSPM

#mock-require

####Simple, intuitive mocking of Node.js modules.

##About

mock-require is useful if you want to mock require statements in Node.js. I wrote it because I wanted something with a straight-forward API that would let me mock anything, from a single exported function to a standard library.

##Usage

var mock = require('mock-require');

mock('http', { request: function() {
  console.log('http.request called');
}});

var http = require('http');
http.request(); // 'http.request called'

##API

mock(path, mockExport)

path: String

The module you that you want to mock. This is the same string you would pass in if you wanted to require the module.

This path should be relative to the current file, just as it would be if you were requireing the module from the current file. mock-require is smart enough to mock this module everywhere it is required, even if it's required from a different file using a different relative path.

mockExport : function

The function you want to be returned from require, instead of the module's exported function. This is useful if your module only exports a single function.

mockExport : object

The object you wnat to be returned from require, instead of the module's exported object. This is useful if your module exports a complex object, such as require('fs').

mockExport : string

The module you want to be returned from require, instead of the module's export. This allows you to replace modules with other modules. For example, if you wanted to replace the fs module with the path module (you probably wouldn't, but it's just an example):

require('fs', 'path');
require('fs') === require('path'); // true

This is useful if you have a mock library that you want to use in multiple places. For example:

test/spy.js:

module.exports = function() {
    return 'this was mocked';
};

test/a_spec.js:

var mock = require('mock-require');
mock('../some/dependency', './spy');
...

test/b_spec.js:

var mock = require('mock-require');
mock('../some/other/dependency', './spy');
...

mock.stop(path)

path: String

The module you that you want to stop mock. This is the same string you would pass in if you wanted to require the module.

This will not modify any modules that have already been required, it will only modify modules required after mock.stop is called. For example:

var mock = require('mock-require');
mock('fs', { mockedFS: true });

var fs1 = require('fs');

mock.stop('fs');

var fs2 = require('fs');

fs1 === fs2; // false

##Test npm test