require a json file results in an error: Cannot find module

Question

In a nodej project open in VsCode with checkJs enabled, when a json file is required like

const myFile = require('./my-file.json')

This makes an error [ts] Cannot find module.

How is it possible to remove the error warning?

I tried to:

add "resolveJsonModule": true to the compilerOptions in jsconfig.json, but it does not work.
create a typing.d.ts file with this content:

declare module '*.json' { const value: any; export default value; } But now, there is an error [ts] Type 'typeof import("*.json")' must have a '[Symbol.iterator]()' method that returns an iterator. [2488]

You don't need to specify json extension when you do a require. const myFile = require('./my-file'); — Thomas Lefetz
– Thomas Lefetz, Commented Nov 15, 2018 at 13:08
Thanks but there is the same error if there is no extension. The error shows up because the json file is not a module. (-> it has no module.exports) — François Romain
– François Romain, Commented Nov 15, 2018 at 13:13
Check this answer, maybe that it can help you : stackoverflow.com/questions/49996456/… — Thomas Lefetz
– Thomas Lefetz, Commented Nov 15, 2018 at 13:18

egdfer · Accepted Answer · 2021-04-27 14:55:55Z

22

You should add

"resolveJsonModule":true

as part of compilerOptions to tsconfig.json.

answered Apr 27, 2021 at 14:55

egdfer

3953 silver badges4 bronze badges

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

1 Comment

phil294 Over a year ago

No, this doesn't remove the error, and OP also stated that in his question

gvlasov · Accepted Answer · 2020-06-30 14:16:41Z

21

I had a similar problem when trying to import json from a file in a typescript project.

I used

import * as data from "module/path/filename.json"

instead of

const data = require("module/path/filename.json")

and it worked.

answered Jun 30, 2020 at 14:16

gvlasov

20.3k22 gold badges85 silver badges120 bronze badges

1 Comment

AlxVallejo Over a year ago

This just gives me "Cannot use import statement outside a module"

iwatachan · Accepted Answer · 2022-11-01 11:58:45Z

1

In my case, I had specified outDir and needed to put the json file at the output destination.

answered Nov 1, 2022 at 11:58

iwatachan

3491 gold badge3 silver badges10 bronze badges

Collectives™ on Stack Overflow

require a json file results in an error: Cannot find module

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related