Скачать или смотреть How to Fix Error [ERR_REQUIRE_ESM] When Using ES Modules in Node.js

Learn how to resolve the `Error [ERR_REQUIRE_ESM]` in your Node.js project when trying to load ES Modules with TypeScript. This guide outlines the steps needed to configure your project correctly.
---
This video is based on the question https://stackoverflow.com/q/68427101/ asked by the user 'David Faizulaev' ( https://stackoverflow.com/u/1850978/ ) and on the answer https://stackoverflow.com/a/68428494/ provided by the user 'David Faizulaev' ( https://stackoverflow.com/u/1850978/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Error [ERR_REQUIRE_ESM]: Must use import to load ES Module when running script

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding the Problem

When working with modern JavaScript features such as ES Modules (ESM) in a Node.js environment, developers may encounter the frustrating Error [ERR_REQUIRE_ESM]: Must use import to load ES Module error. This can happen when immature configurations collide, especially while using TypeScript, older module systems, or existing frameworks.

For instance, one developer faced this error while testing the popular image optimization libraries, imagemin and imagemin-mozjpeg, in their TypeScript project. This led to confusion regarding the correct usage of imports in their scripts.

Let’s dissect this issue more closely.

The Error Explained

The error message indicates that the require() function is being used to import an ES Module, which is not allowed. In Node.js, if a package is marked as an ESM (by the presence of "type": "module" in its package.json), it mandates the use of the import statement instead of require().

Here’s a simplified breakdown of the error's components:

Source of the Problem:

The specific module imagemin is an ES Module.

The script(s) attempted to load this module using require().

Quick Fixes Suggested:

Rename the module import to use the import syntax.

Change the ESM configuration in package.json.

Steps to Resolve the Error

To successfully resolve this issue, the developer found a clean and efficient solution by starting a new project with appropriate configurations. Here’s how you can replicate the fix:

Step 1: Setup a New Project

Initialize a New Project:

Create a new directory for your project.

Navigate into the directory and run:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Configure TypeScript

Set up TypeScript:

Install TypeScript and necessary types:

[[See Video to Reveal this Text or Code Snippet]]

Create a tsconfig.json file with the following basic configuration:

[[See Video to Reveal this Text or Code Snippet]]

Step 3: Modify Scripts

Create Your Source Files:

In your src folder, create index.ts and main.ts files with the following content:

index.ts:

[[See Video to Reveal this Text or Code Snippet]]

main.ts:

[[See Video to Reveal this Text or Code Snippet]]

Step 4: Package Updates

Update package.json:
Ensure your package.json includes "type": "module" and relevant scripts:

[[See Video to Reveal this Text or Code Snippet]]

Step 5: Running the Project

Build and Run:

Compile your TypeScript code:

[[See Video to Reveal this Text or Code Snippet]]

Start the application:

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

By setting up a new project with the correct configurations, you can avoid the Error [ERR_REQUIRE_ESM] and properly utilize modern ES Modules in your Node.js projects. This approach not only resolves your issue but also lays a solid foundation for future development.

If you encounter similar errors in the future, remember to review your module type setups and stick to the correct JavaScript import methods. Happy coding!