Looking at a random source file of the express
framework for NodeJS
, there are two lines of the code that I do not understand (these lines of code are typical of almost all NodeJS files).
/**
* Expose `Router` constructor.
*/
exports = module.exports = Router;
and
/**
* Expose HTTP methods.
*/
var methods = exports.methods = require('./methods');
I understand that the first piece of code allows the rest of the functions in the file to be exposed to the NodeJS app, but I don't understand exactly how it works, or what the code in the line means.
What do
exports
andmodule.exports
actually mean?
I believe the 2nd piece of code allows the functions in the file to access methods
, but again, how exactly does it do this.
Basically, what are these magic words: module
and exports
?
To be more specific:
module
is the global scope variable inside a file.
So if you call require("foo")
then :
// foo.js
console.log(this === module); // true
It acts in the same way that window
acts in the browser.
There is also another global object called global
which you can write and read from in any file you want, but that involves mutating global scope and this is EVIL
exports
is a variable that lives on module.exports
. It's basically what you export when a file is required.
// foo.js
module.exports = 42;
// main.js
console.log(require("foo") === 42); // true
There is a minor problem with exports
on it's own. The _global scope context+ and module
are not the same. (In the browser the global scope context and window
are the same).
// foo.js
var exports = {}; // creates a new local variable called exports, and conflicts with
// living on module.exports
exports = {}; // does the same as above
module.exports = {}; // just works because its the "correct" exports
// bar.js
exports.foo = 42; // this does not create a new exports variable so it just works