Node.js require Module
The primary object exported by the require() module is a function. When NodeJS invokes this require() function, it does so with a singular argument – the file path. This invocation triggers a sequence of five pivotal steps:
- Resolving and Loading: The process begins with the resolution and loading of the module.
- Wrapping: The module is then encapsulated within a function wrapper.
- Execution: The function wrapper is executed, bringing the module to life.
- Returning Exports: The module’s exports are returned, making them accessible for use.
- Caching: Finally, the module is cached to optimize future requests.
Each of these steps plays a crucial role in the functioning of the module system, and we’ll delve into each one in greater detail as we progress through this article.
Let’s look at each step in more detail.
Resolving and Loading:
- In this step, Nodes decide which module to load core module or developer module or 3rd-party module using the following steps:
- When require function receive the module name as its input, It first tries to load core module.
- If path in require function begins with ‘./’ or ‘../’ It will try to load developer module.
- If no file is find, it will try to find folder with index.js in it .
- Else it will go to node_modules/ and try to load module from here .
- If file is still not found , then an error is thrown .
Wrapping:
Once the module is loaded , the module code is wrapped in a special function which will give access to a couple of objects. Wrapping is done to give that loaded file a private scope or local scope. So that it can’t be accessed globally.
Folder Structure:
Example 1:
// Caching
const mod = require('./module1.js')
console.log(require("module").wrapper);
Output:
[
'(function (exports, require, module, __filename, __dirname) { ',
'\n});'
]
- Execution: In this part, the code of the module or code inside the wrapper function run by the NodeJS runtime.
- Returning Exports: In this part, require function return the exports of required module. These exports are stored in module.exports.Use module.exports to export single variable/class/function. If you want to export multiple function or variables use exports ( exports.add = (a,b)=>a+b ).
Returning Exports
- Caching: At the end all modules are cached after the first time they are loaded e.g. If you require the same module multiple times, you will get the same result. So the code and modules are executed in the first call and in a subsequent call, results are retrieved from the cache.
Example 2: Lets take an example to understand caching
console.log("Hello w3wiki");
module.exports = ()=> console.log("w3wiki is the best !!");
// Caching
const mod = require('./module1.js');
mod();
mod();
mod();
Output:
Hello w3wiki
w3wiki is the best !!
w3wiki is the best !!
w3wiki is the best !!
What happen when we require() a Module in Node,js
Contact Us