Question

I’m developing an application with node.js and socket.io. I have built a small-scale project with some variables and functions inside a connection-specific block. These functions have access to the variables declared within that block without the need to pass the values in specifically.

This works fine, and is acceptable for a project of this size. However, as I was trying to clean the code up a bit, I looked into factoring those functions out into their own file and found modules declared by using exports.functionname as described here: http://nodejs.org/docs/v0.3.2/api/modules.html

However, these functions do not have access to the variables within the same block as they normally do when being require()’d in instead of actually being declared in the file.

Is there some way to make functions in an external file behave as if they were declared locally in nodejs?

Answer 1

There isn’t without hacking the module system, which is exactly what I did. https://github.com/Benvie/Node.js-Ultra-REPL/blob/master/lib/ScopedModule.js

I can’t say I recommend it for production. Basically the issue is more with JavaScript itself. Node wraps modules in a function so they have their own private scope. The only way to share in that scope is to be executed inside that function which wouldn’t really work for a module (modular…) system. The only other scope is global which also isn’t desirable.

The trick I used to get around it is in changing that wrapper function to have dynamic properties based on an externally defined set of module imports so that from inside the module wrapper all those parameters look like they’re magically defined but aren’t global.

Node’s module wrapper looks like this:

(function (exports, module, require, __filename, __dirname){
  /**module**/
})

Where mine simply adds more parameters and ensures they’re resolved before executing the module wrapper.

I have it read a file named “.deps.json” in a given folder before loading a module.
An example one would be like this

[{
    "providers": [ "./utility/",
                   "./settings/" ],
    "receivers": [ "*" ]
}]

So it will load the modules in those subfolders and then expose each one as a parameter in the wrapper, named based on the filename.