如何将另一个模块中的类型用作JSDoc返回/ param类型

时间:2018-05-07 21:45:11

标签: javascript node.js webstorm jsdoc discord.js

我正在尝试使用JSDoc来记录我正在制作的机器人的一些功能:

const Discord = require("discord.js");

/**
 * Returns and empty embed with the bot's default settings
 * @param u - The user that executed the command
 * @returns {Discord.RichEmbed}
 */
exports.getDefaultEmbed = function(u) {
    let embed = new Discord.RichEmbed();
    embed.setColor(0xFA632A);
    if (u) embed.setFooter(u.tag, u.displayAvatarURL);
    return embed;
};

如您所见,此函数从discord.js模块返回RichEmbed对象,但WebStorm似乎不喜欢这样。

WebStorm doesn't seem to like that

那么,我如何使用JSDoc中另一个模块的类型?

1 个答案:

答案 0 :(得分:0)

由于任何WebstormProblem模块名称中带有.点/句点的模块都会导致问题。

看来对我有用的一种解决方法是,使用ESMA6并使用反引号来要求该模块。

带有常规引号

With regular quotes

带有反引号

With back quotes