有没有可能在打字稿中标记一些不被推荐的内容?

我正在用一个不推荐的方法为 Javascript API 编写类型脚本定义。下面是文档的摘录(他们说是 API,但只是关于这个单一的方法) :

这个 API 没有任何效果。它是为了兼容而维护的 目的。

出于兼容性的考虑,我还想在定义文件中记录这个方法。但是如果可能的话,我希望以某种方式传达,它已经被否定了。

虽然我当前的问题只是关于定义文件中的弃用,但我还希望在其他代码中使用这个特性。因此,问题更一般: 我怎样才能在打印文本中标记不推荐的内容?

64400 次浏览

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

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

此外,埃斯林特规则还可以查看不推荐的方法并警告它们的使用情况。