如何将导出函数标记为在打字稿中某处使用

问题描述 投票:0回答:0

我有这样的东西:

  • 具有导出功能的模块
  • 一个解析器函数,它将
    require
    通过像
    module-name/function-name
  • 这样的别名
  • 其他 repo 中的一个 json 文件,它映射要调用的页面和函数以通过这些异步函数加载页面数据。

module-name
只是一个目录名称,
index.js
将是
require
-ed.

解析器函数是这样工作的:

export function resolveModuleFunction(moduleName, functionName) {
    if (moduleName.indexOf('~/modules') === 0) {
        moduleName = moduleName.replace('~/','../');
    } else if (moduleName.indexOf('~modules/') === 0) {
        moduleName = moduleName.replace('~modules/','../modules/');
    } else if (moduleName.indexOf('~/') === 0) {
        moduleName = moduleName.replace('~/','../');
    }
    return function(...params) {
        let moduleInstance = require(moduleName);
        if (moduleInstance.default) {
            moduleInstance = moduleInstance.default;
        }
        return moduleInstance[functionName].apply(moduleInstance, params);
    };
}

它有效,我现在想要得到的只是向 IDE 解释要通过这些动态引用使用的函数 - e。 G。在其他带有标记的回购协议中使用这些别名,“在其他地方使用”,并避免这些“模块 Y 的导出函数 X 未使用”。

我不想现在将系统的那部分重构为将在代码中注册页面的打字稿文件。

我只是在寻找一种方法(可能是 JSDoc?)来标记要在某处使用的导出函数?

我考虑制作一些

exported-functions.md
文件,其中这些模块及其功能将列在
JS
降价块中,既用于文档目的,也用于获得被认为“在某处使用”的导出函数的效果。

是否有其他方法可以实现它,在每个函数的 JSDoc 中使用一些关键字?

javascript typescript jsdoc
© www.soinside.com 2019 - 2024. All rights reserved.