docs: add note about no-deprecated with TypeScript (#227)

un-ts · Jan 17, 2025 · bf49621 · bf49621
1 parent f87804d
commit bf49621
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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