Node.js – use of module.exports as a constructor

by

CommonJS modules allow two ways to define exported properties. In either case you are returning an Object/Function. Because functions are first class citizens in JavaScript they to can act just like Objects (technically they are Objects). That said your question about using the new keywords has a simple answer: Yes. I’ll illustrate…

Module exports

You can either use the exports variable provided to attach properties to it. Once required in another module those assign properties become available. Or you can assign an object to the module.exports property. In either case what is returned by require() is a reference to the value of module.exports.

A pseudo-code example of how a module is defined:

var theModule = {
  exports: {}
};

(function(module, exports, require) {

  // Your module code goes here

})(theModule, theModule.exports, theRequireFunction);

In the example above module.exports and exports are the same object. The cool part is that you don’t see any of that in your CommonJS modules as the whole system takes care of that for you all you need to know is there is a module object with an exports property and an exports variable that points to the same thing the module.exports does.

Require with constructors

Since you can attach a function directly to module.exports you can essentially return a function and like any function it could be managed as a constructor (That’s in italics since the only difference between a function and a constructor in JavaScript is how you intend to use it. Technically there is no difference.)

So the following is perfectly good code and I personally encourage it:

// My module
function MyObject(bar) {
  this.bar = bar;
}

MyObject.prototype.foo = function foo() {
  console.log(this.bar);
};

module.exports = MyObject;

// In another module:
var MyObjectOrSomeCleverName = require("./my_object.js");
var my_obj_instance = new MyObjectOrSomeCleverName("foobar");
my_obj_instance.foo(); // => "foobar"

Require for non-constructors

Same thing goes for non-constructor like functions:

// My Module
exports.someFunction = function someFunction(msg) {
  console.log(msg);
}

// In another module
var MyModule = require("./my_module.js");
MyModule.someFunction("foobar"); // => "foobar"

More Related Contents:

  1. module.exports vs exports in Node.js
  2. Difference between “module.exports” and “exports” in the CommonJs Module System
  3. How to stop babel from transpiling ‘this’ to ‘undefined’ (and inserting “use strict”)
  4. Load “Vanilla” Javascript Libraries into Node.js
  5. How can I ‘require’ CommonJS modules in the browser? [closed]
  6. How to check whether a script is running under Node.js?
  7. In the `import` syntax of ES6, how is a module evaluated exactly?
  8. Typescript compiler error when importing json file
  9. Updating a Nested Array with MongoDB
  10. Issue in returning data retrieved from DB queries called in the loop
  11. Preventing SQL injection in Node.js
  12. setImmediate vs. nextTick
  13. Where do the parameters in a javascript callback function come from?
  14. How to get a URL parameter in Express?
  15. Failed to load c++ bson extension
  16. How to write asynchronous functions for Node.js
  17. Nodejs express and promises not doing what I expect
  18. What does “./bin/www” do in Express 4.x?
  19. Node.js Sass version 7.0.0 is incompatible with ^4.0.0 || ^5.0.0 || ^6.0.0
  20. Export HTML table to CSV using vanilla javascript
  21. Undefined return value from the function call Javascritpt
  22. XMLHttpRequest cannot load No ‘Access-Control-Allow-Origin’ header is present on the requested resource. Origin ‘http://localhost:3000’ Google maps
  23. Updating an activity in BotFramework v4 on Teams platform
  24. Require is not defined after installed nodejs
  25. Nodejs: get filename of caller function
  26. require(‘babel/register’) doesn’t work
  27. Whats the smartest / cleanest way to iterate async over arrays (or objs)?
  28. How can I use webpack with express?
  29. How to apply both ValidationPipe() and ParseIntPipe() to params?
  30. Approach to multiple MySQL queries with Node.js

Leave a Comment