`Cannot find module` for my own TypeScript module

Question

I have just published a new TypeScript-based module to the NPM registry. However, when I try to install it and import it in another TypeScript project, VSCode gives me the following error on the import statement: Cannot find module 'mymodulesname'.ts(2307).

This module's source files are compiled to JavaScript to a dist/ folder and definitions (.d.ts) are also generated.

Here's the tree of the published module (the one we download when we npm install):

.
├── dist
│   ├── index.d.ts
│   └── index.js
├── LICENSE
├── package.json
└── README.md

The package.json does contain the following entries:

{
    "main": "dist/index.js",
    "types": "dist/index.d.ts",
    ...
}

Because the module works normally on Runkit (pure JS), I assume the only problem I have is related to TypeScript, and it's not the first time TypeScript tells me a module doesn't exist when missing declaration files are the only problem.

Am I missing a step in the compilation process ? Are my package.json properties wrong ?

Do you see ooafs in node_modules? and test requires another module that is false or success. Try close file and open(maybe you don't download and open, after that you download it) — hong4rc
– hong4rc, Commented Feb 14, 2019 at 17:30

anon · Accepted Answer · 2019-08-14 11:27:02Z

15

Actually, the problem didn't come from my module (ooafs). It was a problem with the tsconfig.json of the project I was using the module in: The module property must be set to commonjs apparently.

Very late edit: Also, I highly recommend setting esModuleInterop to true which allows you to import non-es6 modules in a more natural manner.

edited Aug 14, 2019 at 11:27

answered Feb 14, 2019 at 21:00

anon

6971 gold badge5 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

John Demetriou Over a year ago

please explain more what you mean about commonjs.

Jake Cronin Over a year ago

switching to "module": "commonjs" from "module": "es6" in compilerOptions of the tsconfig.json also fixed my error, but I do not know why. Does anybody understand this?

Aurélien Over a year ago

It seems like touching tsconfig.json makes vscode reload the project and finally find the modules. It is not about the commonjs value for me, just about touching the file. I achieve the same results by pressing F1 and running "TypeScript: Reload Project".

dustbuster Over a year ago

This worked for me. I wrote a new tsconfig, tsc --init and took the parts like "module": "commonjs", and applied it to my existing file. There's also parts in this that point to "es2017", this is an old article, but it at least got me in the right place!

Ananay Gupta · Accepted Answer · 2023-01-10 14:58:44Z

1

The answer is not the fix, and is certainly not ideal when you have to use top-level awaits (which don't work on commonjs).

You want to make sure your import path is the final file that node will try and load. So you cannot rely on folders resolving to folder/index.js and you cannot rely on giving file names without extensions (give the ".js" extension)

answered Jan 10, 2023 at 14:58

Ananay Gupta

4065 silver badges16 bronze badges

Collectives™ on Stack Overflow

`Cannot find module` for my own TypeScript module

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related