Skip to content

Introduction to CommonJS

The CommonJS module specification is the standard used in Node.js for working with modules. Modules are very cool, because they let you encapsulate all sorts of functionality, and expose this functionality to other JavaScript files, as libraries

The CommonJS module specification is the standard used in Node.js for working with modules.

Client-side JavaScript that runs in the browser uses another standard, called ES Modules

Modules are very cool, because they let you encapsulate all sorts of functionality, and expose this functionality to other JavaScript files, as libraries. They let you create clearly separate and reusable snippets of functionality, each testable on its own.

The huge npm ecosystem is built upon this CommonJS format.

The syntax to import a module is:

const package = require('module-name')

In CommonJS, modules are loaded synchronously, and processed in the order the JavaScript runtime finds them. This system was born with server-side JavaScript in mind, and is not suitable for the client-side (this is why ES Modules were introduced).

A JavaScript file is a module when it exports one or more of the symbols it defines, being them variables, functions, objects:

uppercase.js

exports.uppercase = (str) => str.toUpperCase()

Any JavaScript file can import and use this module:

const uppercaseModule = require('uppercase.js')
uppercaseModule.uppercase('test')

A simple example can be found in this Glitch.

You can export more than one value:

exports.a = 1
exports.b = 2
exports.c = 3

and import them individually using the destructuring assignment:

const { a, b, c } = require('./uppercase.js')

or just export one value using:

//file.js
module.exports = value

and import it using

const value = require('./file.js')

→ Here's my latest YouTube video

→ Get my JavaScript Beginner's Handbook

→ I wrote 17 books to help you become a better developer, download them all at $0 cost by joining my newsletter

JOIN MY CODING BOOTCAMP, an amazing cohort course that will be a huge step up in your coding career - covering React, Next.js - next edition February 2025

Bootcamp 2025

Join the waiting list