How to get a module’s filename or path with Node?

How to Get a Module’s Filename or Path with Node?

When working with Node.js and TypeScript, there may be instances where you need to retrieve the filename or path of a module. This information can be useful for various purposes, such as debugging or dynamically loading modules. In this article, we will explore different approaches to obtain a module’s filename or path using Node.js.

1. Using the __filename and __dirname Globals

The simplest way to get a module’s filename or path is by utilizing the __filename and __dirname globals provided by Node.js. The __filename global represents the absolute path of the current module’s filename, while __dirname represents the absolute path of the current module’s directory.

Here’s an example:

console.log(__filename);
console.log(__dirname);

The above code will output the absolute path of the current module’s filename and directory, respectively.

2. Using the import.meta.url Property

If you are using ECMAScript modules (ESM) in your TypeScript code, you can leverage the import.meta.url property to obtain the URL of the current module. This URL can then be converted to a file path using the URL module provided by Node.js.

Here’s an example:

import { fileURLToPath } from 'url';

const moduleURL = new URL(import.meta.url);
const modulePath = fileURLToPath(moduleURL);

console.log(modulePath);

The above code will output the file path of the current module.

3. Using the module.filename Property

If you are working with CommonJS modules in your TypeScript code, you can access the filename property of the module object to retrieve the filename of the current module.

Here’s an example:

console.log(module.filename);

The above code will output the filename of the current module.

These are the different approaches you can use to get a module’s filename or path with Node.js and TypeScript. Choose the method that suits your project’s requirements and start utilizing this information to enhance your code’s functionality.

Happy coding!