从方法返回API时,在Node.js模块上设置JSDoc

问题描述

我无法成功设置JSDoc在WebStorm中正常工作。

我有一个模数,如下:

/**
 * @param  { string  } basePath
 * @return { { function(string): any } get }; // <-- ??
 */
function init(basePath) {
    return { get };
}

/**
 * @param  { string } key
 * @return { any    }
 */
function get(key) {
   return {};
}

module.exports = {init,get};

当我按以下方式调用模块时,JSdoc运行良好:

// Usage v1. JSDocs works well
const mod = require("./mod");
mod.init("basePath");
mod.get("key"); // JSDocs shows: function get(key: string): any

但是,我无法使其以这种方式工作:

// Usage v2. JSDocs doesn't work
const mod = require("./mod").init("basePath");
mod.get("key"); // JSDocs shows: rubbish

如何在init的返回API中设置JSDoc,以便为get提供适当的提示?

所需的JSDoc提示:function get(key: string): any

我想问题的一部分是名字get

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)

相关问答

依赖报错 idea导入项目后依赖报错,解决方案:https://blog....
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下...
错误1:gradle项目控制台输出为乱码 # 解决方案:https://bl...
错误还原:在查询的过程中,传入的workType为0时,该条件不起...
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct...