使用VSCode扩展包括运行时类型定义

Posted 2021-05-03

我正在开发一个库，允许用户从另一个应用程序内部运行Node进程。该库名为“max-api”;用于将数据发送到主机应用程序的函数通过Node模块公开，并以预期的方式加载：

const maxAPI = require("max-api");

但是，用户永远不会直接与此模块交互。相反，当主机应用程序启动Node进程时，它会拦截对require的调用，检查模块的名称是否为“max-api”，如果是，则提供模块。

这很好用，唯一的问题是我们无法为这个模块提供类型定义。因此，用户不会在“max-api”模块中获得任何自动完成或功能验证。我正在考虑编写一个VSCode扩展来提供这些，但我不是100％确定如何开始。提前感谢任何建议。

答案

你可以写一个TS打字文件（见Definitely Typed）。这将安装在node_modules/@types中，vscode将自动选择它以为您的模块提供代码完成。