Javascript Question posted in
A very good W3school tutorial can be found here.

How can I make JSDoc/TypeScript understand JavaScript imports?

I have added // @ts-check to a JavaScript file to use JSDoc. Suddenly I get errors in VS Code for functions included with a script tag:

<script src="imported-file.js"></script>

I can silence these by adding a lot of // @ts-ignore (or maybe other ways?). But that would in my case just make JSDoc/TypeScript a burden.

So instead I wonder what types of ES6 includes/imports JSDoc/TypeScript can handle in VS Code. Can it handle module imports like this one below?

<script type="module" src="imported-file.js"></script>

Can it handle dynamic imports?

const myImportedModule = await import("imported-file.js");

Is there any good documentation about this?

EDIT:
I get the errors when I use the imported functions that are declared in "imported-file.js". They are in the global scope (as seen by JavaScript) just as Jared Smith understood it. The functions are not used in "imported-file.js" and I see no JSDoc errors there.

Tags:

2

Answers


  1. Chosen as BEST ANSWER
    0

    Thanks for your efforts. The solution I found easiest to work with was to just redefine the functions I needed from "imported-file.js". Let say I have a function called myFun in this file. I might then just add a statement like this:

    // @ts-ignore
const TSmyFun = myFun;

    and then do a simple search and replace. This way I can avoid having a lot of // @ts-ignore for every place where I call myFun.

    If you want to add JSDoc and type checking just write a new function TSmyFun.


  2. 0

    I’m not sure I understand the problem you’re describing, but I think what you’ll want to do is use the import keyword when defining the type in your JSDocs. For example

    // imported-file.js

/**
 * @param {string} x
 * @return {string}
 */
export const identity = x => x

    and then where it’s imported

    // other-file.js
/**
 * @type {import('./imported-file.js').identity}
 */
const id = identity

    If that isn’t what you’re looking for, then I’d need more details about what your specific setup looks like.

    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search