Sentry Answers>Node.js>

`module.exports` in Node.js

`module.exports` in Node.js

David Y.

—

The problem

What is the purpose of Node.js’s module.exports and do I use it?

The solution

Node.js uses the CommonJS module system to allow developers to distribute their code across multiple files and make use of third-party libraries. module.exports is part of the CommonJS specification – it defines the object that is created when a file is imported using require(). This gives developers control over which parts of a file can be accessed externally, allowing for encapsulation.

Consider the following module code, which provides methods for retrieving names in different formats.

Click to Copy
// names.js module
function lastname() { // private function
  return "Doe";
}

function firstname() { // private function
  return "Jane";
}

function firstnameLastname() { // public function
  return `${firstname()} ${lastname()}`;
}

function lastnameFirstname() { // public function
  return `${lastname()}, ${firstname()}`;
}

module.exports = { firstnameLastname, lastnameFirstname }; // object to be returned by require()

This module contains four functions, but only the last two are included in module.exports. If we require() this module in another file, we will not be able to call firstname() or lastname().

Click to Copy
const names = require("names.js"); // require() returns the object assigned to module.exports

console.log(names.firstnameLastname()); // will print "Jane Doe"
console.log(names.lastnameFirstname()); // will print "Doe, Jane"

console.log(names.firstname()); // will produce an error
console.log(names.lastname()); // will produce an error
  • SentryWorkshop: Debugging your Node.js Project With Sentry (opens in a new tab)
  • Syntax.fmListen to the Syntax Podcast (opens in a new tab)
  • Community SeriesIdentify, Trace, and Fix Endpoint Regression Issues (opens in a new tab)
  • ResourcesBackend Error Monitoring 101 (opens in a new tab)
  • Syntax.fm logo
    Listen to the Syntax Podcast (opens in a new tab)

    Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.

    SEE EPISODES

Considered “not bad” by 4 million developers and more than 150,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

learn more about sentry (opens in a new tab)join our discord (opens in a new tab)