Installation

varb=require("browserify")({debug:true});b.use(require("rewire").browserify);

Examples

varrewire=require("rewire");// rewire acts exactly like require.varmyModule=rewire("../lib/myModule.js");// Your module will now export a special setter and getter for private variables.myModule.__set__("myPrivateVar",123);myModule.__get__("myPrivateVar");// = 123// This allows you to mock almost everything within the module e.g. the fs-module.// Just pass the variable name as first parameter and your mock as second.myModule.__set__("fs",{readFile:function(path,encoding,cb){cb(null,"Success!");}});myModule.readSomethingFromFileSystem(function(err,data){console.log(data);// = Success!});// All later requires will now return the module with the mock.myModule===require("./myModule.js");// = true// You can set different variables with one call.myModule.__set__({fs:fsMock,http:httpMock,someOtherVar:"hello"});// You may also override globals. These changes are only within the module, so// you don't have to be concerned that other modules are influenced by your mock.myModule.__set__({console:{log:function(){/* be quiet */}},process:{argv:["testArg1","testArg2"]}});// But be careful, if you do something like this you'll change your global// console instance.myModule.__set__("console.log",function(){/* be quiet */});// By getting private variables you can test for instance if your// module is in a specific stateassert.ok(myModule.__get__("currentState")==="idle");// You can also disable caching when loading the rewired module. All// subsequent calls of require() will than return the original module again.rewire("./myModule.js")===require("./myModule.js");// = truerewire("./myModule.js",false)===require("./myModule.js");// = false// Every call of rewire returns a new instance and overwrites the old// one in the module cache.rewire("./myModule.js")===rewire("./myModule.js");// = false// If you want to remove all your rewired modules from// cache just call rewire.reset().// Do this after every single unit test to ensure a clean testing environment.rewire.reset();

Credits