Typescript 检查导出的接口

Posted 2023-03-13

【中文标题】Typescript 检查导出的接口

【英文标题】：Typescript check exported interface

【发布时间】：2020-03-06 08:32:45

【问题描述】：

如何对模块的导出符号进行类型检查？

例如，考虑一个基于插件的系统，其中插件必须实现和导出预定义的 API（例如函数原型或接口）

type MyPluginCallback = (foo: string) => number;

在实现插件时，如果插件没有实现给定的 API，我希望出现构建错误。

/* OK */
module.exports = function myPlugin(foo: string): number 
  /* ... */


/* Error, wrong prototype */
module.exports = function myPlugin(bar: number): number 
  /* ... */

打字稿可以吗？如果有，怎么做？

【问题讨论】：

该插件是否来自您拥有的节点模块？如果是这样，请检查您可以共享您的打字稿配置以查看 skipLibCheck 属性的值。

当我实现插件时，我希望看到构建失败，例如，如果在更高版本的消费者项目中更改了 API。

【参考方案1】：

您可以为此使用type assertion as MyPluginCallback。 as MyPluginCallback 在将类型 MyPluginCallback 分配给手头的函数表达式之前执行类型兼容性检查。

type MyPluginCallback = (foo: string) => number

module.exports = function myPlugin_OK(bar: string): number 
  return 42
 as MyPluginCallback // ✅

module.exports = function myPlugin_Error(bar: number): number 
  return 42
 as MyPluginCallback // ?

或者将函数分配给MyPluginCallback类型的变量，然后在第二步中将其导出。

const myPlugin_OK: MyPluginCallback = (bar: string): number => 42 // ✅
const myPlugin_Error: MyPluginCallback = (bar: number): number => 42 // ?

module.exports = myPlugin_OK
module.exports = myPlugin_Error