added documentation

1 files changed, 5 insertions, 4 deletions

diff --git a/lib/rewire.js b/lib/rewire.js
index 0f96e4d..6f1ac7d 100644
--- a/lib/rewire.js
+++ b/lib/rewire.js
@@ -10,7 +10,10 @@ function restoreOriginalWrappers() {
     Module.wrapper[1] = nodeWrapper1;

 }

 

-function rewire(parentModule, filename, mocks, injections, leaks, cache) {

+/**

+ * Does actual rewiring the module. For further documentation @see index.js

+ */

+module.exports = function doRewire(parentModule, filename, mocks, injections, leaks, cache) {

     var testModule,

         nodeRequire,

         wrapperExtensions = "";

@@ -60,6 +63,4 @@ function rewire(parentModule, filename, mocks, injections, leaks, cache) {
     restoreOriginalWrappers();  // this is only necessary if nothing has been required within the module

 

     return testModule.exports;

-}

-

-module.exports = rewire;
\ No newline at end of file
+};
\ No newline at end of file