From bf49621b010d7cfdfd1cb84bd2843031cecfcb72 Mon Sep 17 00:00:00 2001 From: J Rob Gant Date: Fri, 17 Jan 2025 10:25:45 -0500 Subject: [PATCH] docs: add note about `no-deprecated` with TypeScript (#227) --- docs/rules/no-deprecated.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/rules/no-deprecated.md b/docs/rules/no-deprecated.md index f4edffcd3..e3b9c04b1 100644 --- a/docs/rules/no-deprecated.md +++ b/docs/rules/no-deprecated.md @@ -51,6 +51,13 @@ settings: import-x/docstyle: ['jsdoc', 'tomdoc'] ``` +## When Not To Use It + +TypeScript supports [multiple function signatures](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads) +where only some of signatures can be deprecated. This rule does not support this +configuration. Consider using [`@typescript-eslint/no-deprecated`](https://typescript-eslint.io/rules/no-deprecated/) +instead. + ## Worklist - [x] report explicit imports on the import node