Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
docs(eslint-plugin): [no-explicit-any] add alternatives#11199
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -145,6 +145,36 @@ interface Garply { | ||
} | ||
``` | ||
## Alternatives to `any` | ||
Which type(s) to use instead of `any` depends on the context. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I can't find references of other non-straightforward scenarios to add... are there others we should mention? MemberAuthor
| ||
### Type Parameter Constraints | ||
"Generic" type parameters are often used to represent a value of an unknown type. | ||
It can be tempting to use `any` as a type parameter constraint, but this is not recommended. | ||
First, `extends any` on its own does nothing: `<T extends any>` is equivalent to `<T>`. | ||
See [`@typescript-eslint/no-unnecessary-type-constraint`](./no-unnecessary-type-constraint.mdx) for more information. | ||
Within type parameters, `never` and `unknown` otherwise can generally be used instead. | ||
For example, the following code uses those two types in `AnyFunction` instead of `any`s to constrain `Callback` to any function type: | ||
```ts | ||
type AnyFunction = (...args: never[]) => unknown; | ||
function curry<Greeter extends AnyFunction>(greeter: Greeter, prefix: string) { | ||
return (...args: Parameters<Greeter>) => `${prefix}: ${greeter(...args)}`; | ||
} | ||
const greet = (name: string) => `Hello, ${name}!`; | ||
const greetWithDate = curry(greet, 'Logged: '); | ||
greetWithDate('linter'); // => "Logged: Hello, linter!" | ||
``` | ||
See [When to use `never` and `unknown` in TypeScript](https://blog.logrocket.com/when-to-use-never-unknown-typescript) for more information on those types. | ||
## When Not To Use It | ||
`any` is always a dangerous escape hatch. | ||