Node.js ES Modules: Mastering `import` and `export` 🎯

beginner
14 min

Node.js ES Modules: Mastering import and export 🎯

Welcome to this comprehensive guide on ES Modules in Node.js! This tutorial is designed to help both beginners and intermediates understand the powerful features of importing and exporting modules, making your Node.js applications more modular, manageable, and efficient.

What are ES Modules? 📝

ES Modules (also known as ECMAScript modules) are a part of the JavaScript standard, allowing developers to create reusable and self-contained code snippets. They are a significant improvement over CommonJS, as they address issues like implicit globals and circular dependencies.

Understanding import and export 💡

Importing Modules

Importing a module in Node.js is as easy as using the import keyword followed by the module name.

javascript
// Importing a module named 'myModule' import { someFunction } from 'myModule';

You can import the entire module if it's a CommonJS module (i.e., .js or .json files) by using the require() function.

javascript
// Importing the entire 'myModule' const myModule = require('./myModule');

Exporting Modules

To make a module reusable, you need to export functions, classes, or variables using the export keyword.

javascript
// myModule.js // Exporting a function export function someFunction() { // Your code here }

You can also export multiple functions, classes, or variables from a single file.

javascript
// myModule.js // Exporting multiple functions export function function1() { // Your code here } export function function2() { // Your code here }

Importing and Exporting Default Exports 💡

When a module has a default export, you can import it using the import keyword without curly braces.

javascript
// myModule.js // Default export export default function defaultFunction() { // Your code here } // In another file import defaultFunction from 'myModule';

Module Resolution and node_modules 📝

Node.js uses a specific set of rules to locate and load the requested module. This process is called module resolution. When you import a module, Node.js looks for it in the following order:

  1. Current directory (local module)
  2. Node.js built-in modules
  3. node_modules directory of the current project
  4. Parent directories (up to the root directory) node_modules

When importing a third-party module, it's usually located within the node_modules directory.

CommonJS vs. ES Modules 📝

ES Modules and CommonJS have their differences. While CommonJS uses require() and exports via object, ES Modules use the import and export syntax. To use ES Modules in Node.js, you need to enable the feature using the --experimental-modules flag.

bash
node --experimental-modules yourScript.mjs

Advanced Examples 💡

Importing Multiple Modules

javascript
import { someFunction1, someFunction2 } from 'myModule1'; import { anotherFunction } from 'myModule2';

Exporting Multiple Functions from a Single File

javascript
// myModule.js export function function1() { // Your code here } export function function2() { // Your code here }

Default Export

javascript
// myModule.js export default function defaultFunction() { // Your code here }

Importing and Using the Default Export

javascript
// Importing and using the default export import defaultFunction from 'myModule'; defaultFunction();

Quiz 📝

Quick Quiz
Question 1 of 1

What is the purpose of the `import` keyword in Node.js?

Quick Quiz
Question 1 of 1

What is the difference between CommonJS and ES Modules in Node.js?