#nodejs_api #typescript
В разработке существует жизненный цикл. Вы можете увидеть его этапы в #nodejs документации в виде stability index. Часть методов помечена как Legacy, т.е. их не стоит использовать как прямо, так и через библиотеки. Аналогичный подход можно использовать в своей кодовой базе. Для этого следует использовать JSdoc
@deprecated. Пример:/** @deprecated use newFunction instead **/function oldFunction() {...}Проверку использования устаревшего кода можно переложить на eslint. Для javascript проектов для этого используется правило import/no-deprecated.
В typescript есть перегрузка функций и устареть может только часть сигнатур. Пример:
function example(userOrId: User): void/** @deprecated use with User instead of user_id **/function example(userOrId: number): voidПоэтому для typescript проектов следует использовать eslint-plugin-deprecation.