Estoy escribiendo definiciones mecanografiadas para una API de Javascript con un método obsoleto. Aquí hay un extracto de la documentación (dicen API pero se trata solo de este único método):
Esta API no tiene ningún efecto. Se ha mantenido por motivos de compatibilidad.
Por motivos de compatibilidad, también me gustaría documentar este método en el archivo de definiciones. Pero si es posible, me gustaría comunicar de alguna manera, que ha quedado en desuso.
Si bien mi problema actual es solo sobre la desaprobación en un archivo de definiciones, también me gustaría usar esta característica en otro código. Entonces, la pregunta es más general: ¿Cómo puedo marcar algo como obsoleto en mecanografiado?
Puede usar los comentarios de JSDoc para marcar el código obsoleto:
/** * @deprecated The method should not be used */ export const oldFunc = () => {}Además, esta regla eslint puede revisar los métodos obsoletos y advertir sobre su uso.