Typescript: importing js libraries that import json file

Question

Some JS libraries (e.g. https://www.npmjs.com/package/winston) require json files in their code (the most common use case being package.json). Typescript will throw an error when importing such libraries, as it only understand .ts and .tsx.

Can we teach typescript how to handle importing json files like the way node handles it?

Matt Bierner · Accepted Answer · 2018-06-05 20:42:15Z

1

TS 2.9 added support for json imports. Just add:

{
  "compilerOptions": {
    "resolveJsonModule": true
  }
}

in your tsconfig.json or jsconfig.json

answered Jun 5, 2018 at 20:42

Matt Bierner

67.3k24 gold badges199 silver badges233 bronze badges

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

3 Comments

Aral Roca Over a year ago

This not solve the problem in my case. Using a library that has an import like require(path.resolve(process.cwd() + '/config.json')). To take the config file from the root path.

Aral Roca Over a year ago

JavaScript works fine, however, using this library on TypeScript throws an error. It can be fixed in some way on the codebase of the lib?

Matt Bierner Over a year ago

Yes, IntelliSense generally cannot resolve dynamic imports like that (especially because that example depends on where the script is run from). In such cases, your best bet is to try explicitly typing the import using jsdoc

Collectives™ on Stack Overflow

Typescript: importing js libraries that import json file

1 Answer 1

3 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Related