How to import js in npm package with typescript and javascript

Question

I pulled down a library that contains Typescript and it's javascript version.

When declaring import Library from "@scope/library", my app can only access the typescript, even when I add the js extension.

How can I import the js file instead? I get errors on types.

Arash Motamedi · Accepted Answer · 2019-06-11 21:46:06Z

1

You can override the package's default entry point:

const myObj = require("../node_modules/library/path/to/dist/file.js");

like you would reference any other file in your project structure.

Another way to get Typescript to shut up about typings is to require instead of import:

const myObj = require("@scope/library");

This way you don't have to worry about resolving exactly the right js file, and can still benefit from the Node module resolution mechanism.

edited Jun 11, 2019 at 21:46

answered Jun 11, 2019 at 20:22

Arash Motamedi

10.8k7 gold badges38 silver badges44 bronze badges

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

4 Comments

asunrey Over a year ago

I considered this but feared 'bad practice'.

Arash Motamedi Over a year ago

Yeah it is a bit of a backdoor solution, but if it gets you unblocked maybe that's fine :) Caution: the project folder structure and the file names and routes could be different in another version of the package. So, be on the lookout for that if you update your dependencies. Finally, if this is a library you care about, consider contributing to its source and fixing whatever's wrong with their types so that you and others in the community can benefit from the improvement.

asunrey Over a year ago

I appreciate the additional information, it is exactly what I was looking for. Keeping up with the new and the old javascript methods has been a rough spot in the learning process. Thanks!

Arash Motamedi Over a year ago

Oh yes! I had a similar experience. Had done some front-end coding years ago (think jQuery era) then took a break for a while. Coming back to the world of Javascript coding was just astounding! But hang in there, there's a lot of good resources and smart people out there to help, and Javascript has really become a vibrant viable language, community, ecosystem :)

JamesQuigley · Accepted Answer · 2019-06-11 20:24:22Z

0

If you're getting issues with the types, you either need to install the types for the package

npm install -D @types/<package> yarn add -D @types/<package>

Or you can ignore types by requiring instead of importing:

const package = require('package')

answered Jun 11, 2019 at 20:24

JamesQuigley

163 bronze badges

Collectives™ on Stack Overflow

How to import js in npm package with typescript and javascript

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related