VS Code JS type hint, reference type from node module

Question

I want to document a type that is defined in a node module (discord.js in my case) so that VS Code can help me with autocompletion.

VS Code supports type hints with JSDoc and this should be the correct way to document the type of the parameter client. Yet VS Code, when I hover over the parameter, says that it is of type any.

(parameter) client: any

This is my code so far

module.exports = class Receiver {
    /**
     * @param {module:"discord.js".Client} client
     */
    constructor(client) {
        this.client = client
    }
}

How can I make VS Code understand the correct type of the parameter? It should not be any but Client instead.

PS: I have installed the discord.js module and can successfully use it.

If you require('discord.js') and assign that to a variable, say discord, then you should be able to use @param {discord.Client} client to get your type hinting. — M-N
– M-N, Commented Aug 22, 2019 at 0:53
This does work but I'd rather not have to require('discord.js') because of the overhead and I would not use the variable discord anywhere in my code. (discord would be an unused variable) — Wendelin
– Wendelin, Commented Aug 22, 2019 at 12:29
If you're using Closure Compiler than you'd want to define an extern for discord.js. With regard to defining but not using require('discord.js); I agree this is the right solution, and that you should use some sort of tree shaking, whether it be Closure Compiler's "Advanced Optimizations" or Rollup, or a WebPack config, to avoid the file being bundled. — Graham P Heath
– Graham P Heath, Commented Aug 22, 2019 at 15:22
I think I can get this work this way, however I am still interested if there is a "better" solution that does not require require('discord.js') — Wendelin
– Wendelin, Commented Aug 22, 2019 at 20:53

Jespertheend · Accepted Answer · 2021-12-09 15:44:26Z

1

It's not official jsdoc.app syntax, but it works for IntelliSense/TypeScript:

module.exports = class Receiver {
    /**
     * @param {import("./discord.js").Client} client
     */
    constructor(client) {
        this.client = client
    }
}

answered Dec 9, 2021 at 15:44

Jespertheend

2,42027 silver badges42 bronze badges

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

Collectives™ on Stack Overflow

VS Code JS type hint, reference type from node module

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related