Importing a JS module in a Typescript file

Question

I am developing a website in TS in which I have to call an unofficial API, that is https://www.npmjs.com/package/reverso-api. The whole module is written in JS, and as described in the docs, the proper way to import the module in JS is

const Reverso = require('reverso-api');
const reverso = new Reverso();

Unluckily, I am developing in TypeScript. I have no idea how to import the module in my project in order to make it works. How can I do that?

you could use this library instead: npmjs.com/package/@ablanc/reverso-api — code_monk
– code_monk, Commented Jun 12, 2022 at 15:10

Son Nguyen · Accepted Answer · 2022-06-12 14:53:53Z

1

If this package doesn't have a type definition, you can use a temporary shorthand declaration so TypeScript won't yell at you. This makes all imports from reverso-api have any type, which you might have guessed is not very safe, but it's all we have right now.

declare module 'reverso-api';

Reference: https://www.typescriptlang.org/docs/handbook/modules.html#shorthand-ambient-modules

answered Jun 12, 2022 at 14:53

Son Nguyen

1,82712 silver badges16 bronze badges

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

2 Comments

Leonardo Carlassare Over a year ago

Perfect!! So, considering the steps: 1) Go to node_modules/reverso-api, and create a index.d.ts, with declare module 'reverso-api'; written inside. 2) in a file, for example, bar.ts, I have to import it with the statement import {reverso-api} from reverso-api ?

Son Nguyen Over a year ago

@LeonardoCarlassare You can create a .d.ts file anywhere in your code, add this line and be done. Afterwards you can import and use this package as normal, nothing changes const Reverso = require('reverso-api'); (just make sure this is the correct usage of the package). I don't recommend put the type declaration inside node_modules though, it should be checked in with git. If this helps, can you upvote and mark is the accepted answer to help others with the same question? ;)

Collectives™ on Stack Overflow

Importing a JS module in a Typescript file

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related