首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何使用来自另一个模块的类型作为JSDoc返回/param类型

如何使用来自另一个模块的类型作为JSDoc返回/param类型
EN

Stack Overflow用户
提问于 2018-05-07 21:45:10
回答 1查看 800关注 0票数 3

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

代码语言:javascript
复制
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;
};

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

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

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2018-08-22 17:46:18

由于WebstormProblem的存在,任何在其模块名中带有.点/句点的模块都会引起问题。

在我看来可行的一个解决方法是,使用ESMA6并使用反引号来要求模块。

有规则的引号

带反引号

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/50222897

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档