Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about using with TypeScript #227

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/rules/no-deprecated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading