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, Nov 15 '18 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, Nov 15 '18 at 13:13
Check this answer, maybe that it can help you : https://stackoverflow.com/questions/49996456/importing-json-file-in-typescript — Thomas Lefetz, Nov 15 '18 at 13:18

score 19 · Answer 1 · answered Apr 27 '21 at 14:55

19

You should add

"resolveJsonModule":true

as part of compilerOptions to tsconfig.json.

answered Apr 27 '21 at 14:55

egdfer

score 18 · Answer 2 · answered Jun 30 '20 at 14:16

18

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 '20 at 14:16

gvlasov

5

This just gives me "Cannot use import statement outside a module" – AlxVallejo Feb 11 '22 at 21:22

score 0 · Answer 3 · answered Nov 01 '22 at 11:58

0

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

answered Nov 01 '22 at 11:58

iwatachan

3 Answers3