是否可以在打字稿中将某些内容标记为已弃用？

Question

我正在使用已弃用的方法为 Javascript API 编写打字稿定义。这是文档的摘录（他们说 API，但它只是关于这个单一方法）：

该API没有任何作用。为了兼容性而对其进行了维护 目的。

出于兼容性目的，我还想在定义文件中记录此方法。但如果可能的话，我想以某种方式传达它已被弃用。

虽然我当前的问题只是关于定义文件中的弃用，但我也想在其他代码中使用此功能。所以问题更普遍：如何在打字稿中将某些内容标记为已弃用？

Answer 1

您可以使用 JSDoc 注释来标记已弃用的代码:

/**
 * @deprecated The method should not be used
 */
export const oldFunc = () => {}

ESLint 使用 plugin-deprecation 来查看已弃用的方法并警告其使用情况。

VSCode 还支持已弃用的标签。