Как использовать тип из другого модуля в качестве типа возврата / параметра JSDoc - PullRequest
0 голосов
/ 08 мая 2018

Я пытаюсь использовать 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;
};

Как видите, эта функция возвращает объект RichEmbed из модуля discord.js, но WebStorm, похоже, не похож на это.

WebStorm doesn't seem to like that

Итак, как мне использовать тип из другого модуля в JSDoc?

1 Ответ

0 голосов
/ 22 августа 2018

Из-за WebstormProblem любые модули с . точкой / периодом в имени модуля могут вызвать проблемы.

Обходной путь, который, кажется, работает на моем конце, - используйте ESMA6 и используйте обратные кавычки, чтобы запросить модуль.

С обычными кавычками

With regular quotes

С обратными кавычками

With back quotes

...