是否可以在打字稿中将某些内容标记为已弃用?
Is it possible to mark something as deprecated in typescript?
我正在使用已弃用的方法为 Javascript API 编写打字稿定义。这是文档的摘录(他们说 API 但它只是关于这个单一的方法):
This API has no effect. It has been maintained for compatibility
purpose.
出于兼容性目的,我还想在定义文件中记录此方法。但如果可能的话,我想以某种方式传达它已被弃用。
虽然我当前的问题只是关于定义文件中的弃用,但我还想在其他代码中使用此功能。所以问题更笼统:如何在打字稿中将某些内容标记为已弃用?
您可以使用 JSDoc 注释来标记已弃用的代码:
/**
* @deprecated The method should not be used
*/
export const oldFunc = () => {}
此外,this eslint rule 可以查看已弃用的方法并对它们的使用提出警告。
我正在使用已弃用的方法为 Javascript API 编写打字稿定义。这是文档的摘录(他们说 API 但它只是关于这个单一的方法):
This API has no effect. It has been maintained for compatibility purpose.
出于兼容性目的,我还想在定义文件中记录此方法。但如果可能的话,我想以某种方式传达它已被弃用。
虽然我当前的问题只是关于定义文件中的弃用,但我还想在其他代码中使用此功能。所以问题更笼统:如何在打字稿中将某些内容标记为已弃用?
您可以使用 JSDoc 注释来标记已弃用的代码:
/**
* @deprecated The method should not be used
*/
export const oldFunc = () => {}
此外,this eslint rule 可以查看已弃用的方法并对它们的使用提出警告。