Cannot find module 'X' error in Node.js

Cannot find module 'X' error in Node.js #

The "Cannot find module" error in Node.js occurs for multiple reasons:

1. Forgetting to install a third-party package with npm i somePackage.
2. Pointing the node command to a file that doesn't exist.
3. Having an outdated version of the package, or an IDE or development server glitch.
4. Forgetting to install type definitions for a package in a TypeScript project.

To solve the "Cannot find module" error in Node.js, make sure to install the package from the error message if it's a third-party package, e.g. npm i somePackage. If you get the error with a local module, make sure to point the node command to a file that exists.

Open your terminal in your project's root directory (where your package.json file is located) and run the following commands:

Copied!
npm install uuid

# 👇️ only if you use TypeScript
npm install --save-dev @types/uuid

This will add the third-party package to the dependencies of your project.

If the error is not resolved, try to delete your node_modules and package-lock.json (not package.json) files, re-run npm install and restart your IDE.

Copied!
# 👇️ delete node_modules and package-lock.json
rm -rf node_modules
rm -f package-lock.json

# 👇️ clean npm cache
npm cache clean --force

npm install

If you are getting the "Cannot find module" error when trying to run a local file, make sure that the path you passed to the node command points to a file that exists.

For example, if you run node src/index.js, make sure that the path src/index.js points to an existing file.

If you need to install a package globally to be able to run it on the command line from every directory, use the -g flag.

Copied!
npm i -g some-package

# 👇️ this links globally installed package to local node_modules folder
npm link some-package

Copied!
# 👇️ If you got permissions error, run with sudo
sudo npm i -g some-package

npm link some-package

The npm link command creates a symbolic link from the globally installed package to the node_modules/ directory of the current folder.

If you are getting the error in a TypeScript project, install the type definitions for the package by running npm i -D @types/some-package and make sure the types array contains the string node.

Copied!
{
  "compilerOptions": {
    "types": [
      "node"
    ]
  },
}

If you're still getting the "Cannot find module" error in your Node.js project, open your package.json file and make sure it contains the name of the package in the dependencies object.

Copied!
{
  // ... rest
  "dependencies": {
    "some-module": "^2.8.5",
  },
}

You can try to manually add the line and re-run npm install.

Copied!
npm install

Or install the latest version of the package:

Copied!
npm install some-module@latest

If the error is still not resolved, open your terminal and check if you have Node.js installed by running the following command:

Copied!
node -v

If you get a version number back, you have Node.js installed, otherwise install it by visiting the official Node.js page.

If you get the error because a local file is not found, try to use the Tab key after the node command to autocomplete the path to the module you are trying to run.

The path pointing to the module you're trying to run is relative to the directory in which you opened your terminal.

Make sure the path to your project does not contain a hash # symbol or any other special characters that your operating system might have issues resolving. For example, don't use a path like my-folder#3/my-project/my-file.js (contains a hash #).

Special characters in your directory path might cause the "Cannot find module" error.

Conclusion #

To solve the "Cannot find module" error in Node.js, make sure to install the package from the error message if it's a third-party package, e.g. npm i somePackage. If you get the error with a local module, make sure to point the node command to a file that exists.